refactor: update architecture documentation and add commenting standards
This commit is contained in:
@@ -9,8 +9,10 @@ Before planning or implementing product work, read:
|
||||
1. [`CONTEXT.md`](CONTEXT.md) for canonical domain language.
|
||||
2. [`docs/product/mastermind-product-brief.md`](docs/product/mastermind-product-brief.md) for scope and non-goals.
|
||||
3. [`docs/architecture/native-mastermind.md`](docs/architecture/native-mastermind.md) for system boundaries.
|
||||
4. [`docs/privacy/local-first-data-contract.md`](docs/privacy/local-first-data-contract.md) for normative data rules.
|
||||
5. [`docs/product/mvp-acceptance.md`](docs/product/mvp-acceptance.md) for completion criteria.
|
||||
4. [`docs/architecture/system-patterns.md`](docs/architecture/system-patterns.md) and [`docs/architecture/swift-patterns.md`](docs/architecture/swift-patterns.md) for design and implementation standards.
|
||||
5. [`docs/development/commenting-standard.md`](docs/development/commenting-standard.md) for documentation rules.
|
||||
6. [`docs/privacy/local-first-data-contract.md`](docs/privacy/local-first-data-contract.md) for normative data rules.
|
||||
7. [`docs/product/mvp-acceptance.md`](docs/product/mvp-acceptance.md) for completion criteria.
|
||||
|
||||
ADRs under `docs/adr` explain hard-to-reverse decisions. When legacy code or documentation conflicts with the canonical context, the canonical context wins.
|
||||
|
||||
@@ -51,6 +53,19 @@ Use the exact terms in `CONTEXT.md`.
|
||||
|
||||
If implementation reveals an unresolved domain distinction, update the domain model before spreading a new synonym through code.
|
||||
|
||||
## Review Checklist
|
||||
|
||||
При проверке кода (Code Review) обязательно убедитесь в соблюдении следующих пунктов:
|
||||
|
||||
- [ ] Соблюдено Dependency Rule: зависимости направлены внутрь модулей.
|
||||
- [ ] Все внешние I/O и межмодульные взаимодействия закрыты протоколами (Application Ports).
|
||||
- [ ] Состояние инкапсулировано в `actor` или защищено Swift 6 Concurrency.
|
||||
- [ ] Отсутствуют `Task.detached` без явного обоснования и управления жизненным циклом.
|
||||
- [ ] Все публичные и семантически значимые декларации снабжены русским DocC.
|
||||
- [ ] Новые TODO/FIXME содержат ссылку на issue.
|
||||
- [ ] Не нарушен Local-First Data Contract: сырые данные не сохраняются, секреты в Keychain.
|
||||
- [ ] Код соответствует нормативным паттернам из Architecture Playbook.
|
||||
|
||||
## Local-first requirements
|
||||
|
||||
- Raw screen frames, audio, OCR, and complete transcripts are ephemeral.
|
||||
|
||||
Reference in New Issue
Block a user