Files
openspec-schema/examples/project-bootstrap/README.md
T

42 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Заготовки контекста проекта
Этот каталог содержит стартовые файлы для проекта, использующего схему
OpenSpec `use-case-driven`. Схема не устанавливает их автоматически. Скопируйте
`AGENTS.md` и каталог `openspec/context/` в проект с сохранением относительной
структуры и адаптируйте их к его устройству. Этот README служит инструкцией для
комплекта и не предназначен для копирования поверх README проекта.
В комплект входят:
- `AGENTS.md` — навигация по проектному контексту и правила OpenSpec;
- `openspec/context/index.md` — карта постоянных документов проекта;
- `openspec/context/adr/README.md` — правила ведения ADR;
- `openspec/context/adr/ADR-template.md` — заготовка нового решения.
После копирования проверьте и настройте пути в индексе. Добавляйте туда
проектные документы по мере появления; не дублируйте в Context функциональные
требования из `openspec/specs/`. Перед архитектурными изменениями читайте
применимые принятые ADR.
`ADR-template.md` соответствует
`openspec/schemas/use-case-driven/templates/adr.md` в этом репозитории. При
изменении исходного шаблона обновляйте его копию здесь.
После `openspec init` настройте в `openspec/config.yaml` проектные параметры
интеграции YouTrack в существующем блоке `context`, сохранив остальной контекст:
```yaml
context: |
YouTrack project key: <KEY>
YouTrack application label: <APP-NAME>
```
Укажите ключ проекта и имя приложения, которое должно записываться в тег каждой
задачи. Общие правила создания задачи, учёта времени и архивации берутся из
схемы `use-case-driven`. Добавьте также `operations.archive.guidance` из раздела
«Настройка YouTrack» в README схемы: OpenSpec загружает эту подсказку отдельно
при вызове `openspec instructions archive`.
Заготовка не содержит готовых решений или описания бизнес-домена. ADR создаются
в проекте только для конкретных долгосрочных архитектурных решений.