Template
76 lines
6.1 KiB
Markdown
76 lines
6.1 KiB
Markdown
# Инструкции для 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
|
||
явно сообщи о нём и запроси решение владельца.
|
||
|
||
## Git-процесс OpenSpec Change
|
||
|
||
- Для каждой задачи используй одну feature-ветку от целевой ветки репозитория:
|
||
`feature/<task-code>-<task-name>`. Код бери из связанной задачи, имя —
|
||
короткий ASCII slug в нижнем регистре с дефисами. Не переименовывай уже
|
||
используемую ветку вслед за переименованием задачи.
|
||
- Используй эту ветку для двух последовательных PR в одну целевую ветку.
|
||
Обычный push разрешён только в feature-ветку; прямой push в целевую ветку,
|
||
force push и изменение чужих веток запрещены.
|
||
- Первый PR содержит только артефакты планирования OpenSpec: proposal, delta
|
||
specs либо отметку `skip_specs: true`, design, tasks и связанные метаданные.
|
||
Не начинай и не публикуй реализацию до ручного слияния первого PR и
|
||
отдельной команды владельца.
|
||
- После открытия первого PR остановись. Владелец отдельно ревьюит и вручную
|
||
сливает его, сохраняя feature-ветку. Одобрение или слияние сами по себе
|
||
не разрешают продолжать: дождись явной команды владельца в этом чате.
|
||
- После команды проверь в Git, что первый PR действительно слит в целевую
|
||
ветку. Если он ещё не слит, сообщи об этом и жди. После подтверждения
|
||
обнови ту же feature-ветку из целевой и продолжай реализацию в ней.
|
||
- Второй PR содержит реализацию, применимые проверки, документацию и
|
||
обновлённые задачи OpenSpec; добавь ссылку на задачу и первый PR. Для него
|
||
требуется отдельное актуальное ревью и успешные обязательные проверки.
|
||
Оба PR вручную сливает владелец.
|
||
- После запроса правок продолжай только по явной команде владельца. Закрытый
|
||
без слияния PR останавливает процесс до отдельного решения владельца.
|
||
Автоматическое слияние и продолжение по событиям Git не используются.
|
||
|
||
## Task Management
|
||
|
||
Для всех OpenSpec Changes используй скилл `task-tracker`.
|
||
|
||
Task tracker configuration:
|
||
|
||
- Project key: <KEY>
|
||
- Application label: <APP-NAME>
|
||
|
||
Lifecycle:
|
||
|
||
- Если пользователь передал ID задачи YouTrack для начала Explore/Propose или
|
||
change, используй эту задачу как контекст; новую задачу не создавай.
|
||
- При создании change без переданного ID создай или привяжи задачу после
|
||
содержательного proposal.
|
||
- При существенном изменении change синхронизируй существующую задачу.
|
||
- После каждого рабочего сеанса Apply синхронизируй фактическое время.
|
||
- Перед archive выполни финальную синхронизацию; после успешной архивации
|
||
закрой связанную задачу и создай коммит с изменениями change. Начинай сообщение
|
||
коммита с ключа связанной задачи, затем кратко опиши изменения по-русски:
|
||
`CON-27 Правка тестов`. При ошибке archive задачу не закрывай и коммит не создавай.
|
||
- При повторном запросе или незавершённой синхронизации возобнови работу
|
||
с существующей связью, включая архивные changes.
|
||
|
||
Все операции управления задачами выполняй через скилл `task-tracker`.
|