Добавил типовые файлы нового проекта

This commit is contained in:
2026-10-13 23:17:01 +03:00
parent f3cedcc5c3
commit a0fe47d4d3
3 changed files with 80 additions and 0 deletions
+22
View File
@@ -0,0 +1,22 @@
# Инструкции для Codex
## Навигация по контексту
- Начинай с `openspec/context/index.md`, затем читай только документы,
относящиеся к текущей задаче.
- Перед архитектурными изменениями изучай применимые ADR со статусом `Accepted`.
- Не дублируй в проектном контексте функциональные требования из
`openspec/specs/`.
- Поддерживай индекс в актуальном состоянии, когда состав документов меняется.
## OpenSpec
- Для изменений используй workflow OpenSpec Change и Apply.
- При подготовке каждого change оценивай влияние на постоянный контекст проекта
и необходимость создать или обновить ADR и другие документы.
- Если документы контекста нужно изменить, добавляй проверяемые задачи в
`tasks.md` и выполняй их в рамках Apply.
- Если change добавляет, удаляет или переименовывает документы контекста,
обновляй `openspec/context/index.md`.
- Не принимай Proposed ADR самостоятельно. При конфликте запроса с принятым ADR
явно сообщи о нём и запроси решение владельца.
+41
View File
@@ -0,0 +1,41 @@
# Заготовки контекста проекта
Этот каталог содержит стартовые файлы для проекта, использующего схему
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 создаются
в проекте только для конкретных долгосрочных архитектурных решений.
@@ -0,0 +1,17 @@
# Индекс проектного контекста
Используй этот файл как карту постоянных знаний проекта. Сначала определи по
задаче нужные документы и загружай их выборочно. Обновляй индекс при добавлении,
удалении или переименовании документов.
| Путь | Назначение | Когда читать |
| --- | --- | --- |
| `../../README.md` | Обзор проекта и инструкции по запуску | При знакомстве с проектом или изменении его назначения |
| `../../AGENTS.md` | Правила работы Codex и навигации по контексту | В начале работы над задачей |
| `adr/README.md` | Правила оформления, принятия и замены ADR | При подготовке или пересмотре ADR |
| `adr/ADR-template.md` | Заготовка нового архитектурного решения | При создании ADR |
| `adr/ADR-[0-9][0-9][0-9][0-9]-*.md` | Архитектурные решения проекта | Перед архитектурными изменениями — читай только применимые принятые решения |
Добавляй сюда другие документы постоянного контекста с кратким назначением и
условием чтения. Не переноси сюда функциональные требования: актуальные
требования находятся в `../specs/`, а планы изменений — в `../changes/`.