- Зачем: - инженерным навыкам нужна единая конфигурация трекера задач и доменных документов. - Что: - задокументированы Gitea workflow через tea и стандартные triage-метки. - добавлены доменный словарь и правила работы с ADR, research и specs. - Проверка: - git diff --cached --check. - tea --version: 0.15.1.
2.2 KiB
2.2 KiB
Domain Docs
Репозиторий использует single-context layout.
Перед исследованием кода
- Прочитать корневой
CONTEXT.md. - Прочитать относящиеся к задаче решения из
docs/adr/. - Проверить относящиеся к задаче исследования в
docs/research/. - Проверить относящиеся к задаче спецификации в
docs/specs/. - Если документа нет, продолжить молча: доменные документы создаются лениво соответствующими навыками.
Структура
/
├── CONTEXT.md
├── docs/
│ ├── adr/
│ ├── research/
│ │ └── YYYY-MM-DD-slug.md
│ └── specs/
│ └── YYYY-MM-DD-slug.md
└── src/
Назначение документов
CONTEXT.md— каноническая терминология предметной области.docs/adr/— принятые архитектурные решения и их обоснование.docs/research/YYYY-MM-DD-slug.md— результаты исследований, основанные на источниках и экспериментах.docs/specs/YYYY-MM-DD-slug.md— согласованные спецификации изменений.
Терминология
В задачах, тестах, предложениях и документации использовать термины из
CONTEXT.md. Не заменять их синонимами, перечисленными в _Avoid_.
Если нужного понятия нет, проверить, действительно ли это доменный термин.
Существенный пробел передать в domain-modeling.
Конфликты с ADR
Если предлагаемое изменение противоречит существующему ADR, указать конфликт явно и объяснить, почему решение стоит пересмотреть.