Template
52 lines
3.9 KiB
Markdown
52 lines
3.9 KiB
Markdown
# Заготовки контекста проекта
|
||
|
||
Этот каталог содержит стартовые файлы для проекта, использующего схему
|
||
OpenSpec `use-case-driven`. Схема не устанавливает их автоматически. Скопируйте
|
||
`AGENTS.md` и каталог `openspec/context/` в проект с сохранением относительной
|
||
структуры и адаптируйте их к его устройству. Этот README служит инструкцией для
|
||
комплекта и не предназначен для копирования поверх README проекта.
|
||
|
||
В комплект входят:
|
||
|
||
- `AGENTS.md` — навигация по контексту, правила OpenSpec и вызовы `task-tracker`;
|
||
- `openspec/config.yaml` — выбор схемы и начальный контекст 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` с конфигурацией
|
||
проекта, сохранив существующие настройки. Выберите `schema: use-case-driven`
|
||
и дополните предметный контекст. Настройки задач заполняйте в `AGENTS.md`:
|
||
|
||
```markdown
|
||
Task tracker configuration:
|
||
|
||
- Project key: <KEY>
|
||
- Application label: <APP-NAME>
|
||
```
|
||
|
||
Укажите ключ проекта и имя приложения, которым маркируется каждая задача. Скилл
|
||
сохраняет его в строковое поле `Labels`, если оно есть в проекте, иначе — как
|
||
точный тег YouTrack. Если
|
||
пользователь начинает Explore/Propose с переданным ID задачи, используйте эту
|
||
задачу и не создавайте новую.
|
||
Подключите общий скилл `task-tracker` по
|
||
[инструкции корневого README](../../README.md#подключение-из-домашней-директории).
|
||
Создание или привязка, содержательные обновления, учёт времени, закрытие задачи
|
||
и коммит после успешного archive выполняются по Lifecycle из `AGENTS.md`.
|
||
Сообщение коммита должно быть на русском языке и состоять из 4–7 слов. Эти правила не нужно
|
||
добавлять в схему или `config.yaml`. Запуск OpenSpec CLI вне Codex не вызывает
|
||
скилл; для завершения внешней синхронизации обратитесь к агенту.
|
||
|
||
Заготовка не содержит готовых решений или описания бизнес-домена. ADR создаются
|
||
в проекте только для конкретных долгосрочных архитектурных решений.
|