Template
Правки процесс работы с task tracker
This commit is contained in:
@@ -1,104 +1,230 @@
|
||||
# Схема OpenSpec `use-case-driven`
|
||||
# Общие инструменты для OpenSpec и Codex
|
||||
|
||||
`use-case-driven` — переносимая русскоязычная схема OpenSpec, основанная на
|
||||
базовой `spec-driven`. Она задаёт формат артефактов change и спецификаций
|
||||
поведения; подробные правила схемы находятся в
|
||||
[README схемы](openspec/schemas/use-case-driven/README.md).
|
||||
Репозиторий содержит три переиспользуемых артефакта:
|
||||
|
||||
| Артефакт | Назначение | Где находится |
|
||||
|---|---|---|
|
||||
| Схема OpenSpec `use-case-driven` | Русскоязычные спецификации поведения и workflow `proposal → specs / design → tasks → apply` | [`openspec/schemas/use-case-driven/`](openspec/schemas/use-case-driven/) |
|
||||
| Заготовки `AGENTS.md` и `config.yaml` с контекстом проекта | Правила агента, параметры проекта и начальная навигация по постоянным документам | [`examples/project-bootstrap/`](examples/project-bootstrap/) |
|
||||
| Скилл Codex `task-tracker` | Одна задача на change: привязка, метка приложения, синхронизация, учёт времени, archive и коммит | [`skills/task-tracker/SKILL.md`](skills/task-tracker/SKILL.md) |
|
||||
|
||||
## Чем отличается от `spec-driven`
|
||||
Схема и скилл хранятся и развиваются здесь. Подключайте их символическими
|
||||
ссылками из пользовательских каталогов; обновление клона обновляет общий
|
||||
источник. Проектные `AGENTS.md` и `config.yaml` копируйте и адаптируйте:
|
||||
они содержат настройки конкретного приложения.
|
||||
|
||||
- В базовой схеме сценарии оформляются краткими шагами Gherkin `WHEN` / `THEN`.
|
||||
Здесь используются сценарии использования без Gherkin: полные или
|
||||
сокращённые, связанные с функциональными требованиями.
|
||||
- Один `Requirement` описывает завершённую функцию и содержит один `Scenario`.
|
||||
Подробные правила, устойчивые контракты и обязательные ограничения
|
||||
фиксируются в локальных `FR`; HTTP-контракт размещается в `CONTRACT`.
|
||||
- Master-спецификация явно описывает `Purpose`, `Границы` ответственности
|
||||
capability и полный набор `Requirements`. Delta-спецификации меняют требования
|
||||
стандартными операциями OpenSpec.
|
||||
- Инструкции и пояснительный текст ориентированы на русский язык; технические
|
||||
идентификаторы и синтаксис OpenSpec сохраняются.
|
||||
## 1. Схема `use-case-driven`
|
||||
|
||||
## Подключение схемы в проектах
|
||||
В отличие от базовой `spec-driven`, схема описывает поведение полными или
|
||||
сокращёнными use cases без Gherkin. Один `Requirement` задаёт завершённую
|
||||
функцию с одним `Scenario`; локальные `FR` фиксируют подробные правила,
|
||||
устойчивые контракты и ограничения. HTTP-контракт находится в `CONTRACT`.
|
||||
Master specs описывают `Purpose`, границы capability и требования; delta specs
|
||||
используют стандартные операции OpenSpec. Технический синтаксис сохраняется,
|
||||
пояснения пишутся по-русски. Подробности — в [README схемы](openspec/schemas/use-case-driven/README.md).
|
||||
|
||||
Схему можно подключить один раз для всех проектов пользователя. OpenSpec ищет
|
||||
пользовательские схемы в `~/.local/share/openspec/schemas` на macOS и Linux,
|
||||
а в `%LOCALAPPDATA%\openspec\schemas` на Windows. Если задана переменная
|
||||
`XDG_DATA_HOME`, OpenSpec использует `$XDG_DATA_HOME/openspec/schemas` вместо
|
||||
стандартного пути.
|
||||
На macOS/Linux пользовательские схемы находятся в
|
||||
`${XDG_DATA_HOME:-$HOME/.local/share}/openspec/schemas`, на Windows —
|
||||
в `%LOCALAPPDATA%\openspec\schemas`, либо под `XDG_DATA_HOME`, если он задан.
|
||||
|
||||
1. Клонируйте этот репозиторий в удобную папку. Путь к клону можно выбрать
|
||||
самостоятельно.
|
||||
2. В пользовательской папке схем создайте ссылку с именем `use-case-driven`,
|
||||
ведущую на `openspec/schemas/use-case-driven` внутри клона.
|
||||
## 2. Заготовки проектных инструкций и конфигурации
|
||||
|
||||
После `openspec init` перенесите в прикладной проект нужные части
|
||||
[`examples/project-bootstrap/`](examples/project-bootstrap/):
|
||||
|
||||
- [`AGENTS.md`](examples/project-bootstrap/AGENTS.md) — навигация по контексту,
|
||||
правила OpenSpec и вызовы `task-tracker` в жизненном цикле change;
|
||||
- [`openspec/config.yaml`](examples/project-bootstrap/openspec/config.yaml) —
|
||||
выбор схемы и начальный контекст OpenSpec;
|
||||
- `openspec/context/` — индекс контекста, правила ADR и шаблон решения.
|
||||
|
||||
Объедините заготовки с существующими файлами, сохраняя применимые инструкции
|
||||
и настройки проекта. Заполните в проектном `AGENTS.md`:
|
||||
|
||||
```markdown
|
||||
## 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 с русским описанием в 4–7 слов.
|
||||
При ошибке archive задачу не закрывай.
|
||||
- При повторном запросе возобнови незавершённую синхронизацию по существующей
|
||||
связи, включая архивные changes.
|
||||
|
||||
Все операции управления задачами выполняй через скилл `task-tracker`.
|
||||
```
|
||||
|
||||
`Project key` — ключ проекта в трекере, `Application label` — имя приложения,
|
||||
которым маркируется каждая задача. Без обоих значений скилл не создаёт задачу.
|
||||
Заполните эти значения для каждого прикладного проекта в его `AGENTS.md`.
|
||||
Типовая заготовка хранится только в `examples/project-bootstrap/AGENTS.md`.
|
||||
|
||||
В `openspec/config.yaml` укажите `schema: use-case-driven` и дополните
|
||||
предметный контекст и правила OpenSpec. Правила внешнего трекера в этот файл
|
||||
не добавляются. Локальный [`openspec/config.yaml`](openspec/config.yaml)
|
||||
описывает настройки самого репозитория; переносимая заготовка находится
|
||||
в `examples/project-bootstrap/`.
|
||||
|
||||
## 3. Скилл `task-tracker`
|
||||
|
||||
Скилл создаёт или привязывает одну верхнеуровневую
|
||||
задачу на change либо использует явно переданный ID, сохраняет метку приложения,
|
||||
обновляет содержательное описание без копирования `tasks.md`, учитывает время
|
||||
от Explore и коммитит изменения после успешной архивации и синхронизации задачи.
|
||||
|
||||
Границы компонентов:
|
||||
|
||||
| Компонент | Ответственность |
|
||||
|---|---|
|
||||
| Проектный `AGENTS.md` | Когда вызывать скилл, ключ проекта и метка приложения |
|
||||
| `task-tracker` | Логические операции, связь с change и правила провайдера |
|
||||
| OpenSpec | Спецификации, Change, Apply и Archive |
|
||||
| MCP | Технический доступ к внешнему трекеру |
|
||||
|
||||
Текущая реализация использует YouTrack MCP; настройте его доступность в Codex.
|
||||
Выбор поля `Labels` или YouTrack-тега, синхронизация статусов и учёт времени описаны
|
||||
[в едином SKILL.md](skills/task-tracker/SKILL.md).
|
||||
Для смены трекера меняйте только скилл. Перенос существующих
|
||||
задач требует явного соответствия ID, чтобы не потерять историю связи.
|
||||
|
||||
### Связь, сохраняющаяся после archive
|
||||
|
||||
Источник связи — `task-tracker.yaml` внутри каталога change:
|
||||
|
||||
```text
|
||||
openspec/changes/<change-id>/task-tracker.yaml
|
||||
↓ openspec archive
|
||||
openspec/changes/archive/<archive-name>/task-tracker.yaml
|
||||
```
|
||||
|
||||
Archive переносит весь каталог, включая файл связи. После успешного переноса
|
||||
закройте YouTrack-задачу и зафиксируйте относящиеся к change изменения
|
||||
Git-коммитом с русским сообщением из 4–7 слов. Исходный `change_id`,
|
||||
непрозрачный `task_id`, URL и снимок проектных параметров остаются в файле.
|
||||
Не пытайтесь восстанавливать ID только из архивного имени: change сам может
|
||||
начинаться с даты. Сохраняйте файл в Git вместе с change и архивом.
|
||||
Формат и правила восстановления — в
|
||||
[`SKILL.md`](skills/task-tracker/SKILL.md).
|
||||
|
||||
Запись содержит незавершённую операцию и журнал уже учтённого времени.
|
||||
После ошибки MCP скилл проверяет внешнее состояние перед повтором. При
|
||||
неизвестном результате создания или записи времени автоматический повтор
|
||||
запрещён до сверки. Если задача не закрылась после archive, связь и pending
|
||||
остаются в архиве для следующей сессии.
|
||||
|
||||
Это агентный workflow: самостоятельный запуск `openspec archive` вне Codex
|
||||
переносит файл, но не вызывает скилл, не синхронизирует задачу и не создаёт
|
||||
коммит. Для последующей
|
||||
синхронизации попросите Codex использовать `$task-tracker` для архивного change.
|
||||
При одновременной работе нескольких агентов требуется согласовать операции:
|
||||
файл связи не является распределённой блокировкой.
|
||||
|
||||
## Подключение из домашней директории
|
||||
|
||||
### macOS и Linux
|
||||
|
||||
Команды учитывают `XDG_DATA_HOME`, если он задан. Замените путь в `ln -s` на
|
||||
путь к своему клону:
|
||||
Замените `/path/to/openspec-schema` на абсолютный путь к своему клону:
|
||||
|
||||
```sh
|
||||
tooling_repo="/path/to/openspec-schema"
|
||||
schemas_dir="${XDG_DATA_HOME:-$HOME/.local/share}/openspec/schemas"
|
||||
mkdir -p "$schemas_dir"
|
||||
ln -s "/path/to/openspec-schema/openspec/schemas/use-case-driven" \
|
||||
skills_dir="$HOME/.agents/skills"
|
||||
|
||||
mkdir -p "$schemas_dir" "$skills_dir"
|
||||
ln -s "$tooling_repo/openspec/schemas/use-case-driven" \
|
||||
"$schemas_dir/use-case-driven"
|
||||
ln -s "$tooling_repo/skills/task-tracker" "$skills_dir/task-tracker"
|
||||
```
|
||||
|
||||
Codex обнаруживает пользовательские скиллы в `~/.agents/skills` и поддерживает
|
||||
ссылки на каталоги скиллов. Если новый скилл не появился, перезапустите Codex.
|
||||
См. [официальную документацию о скиллах](https://learn.chatgpt.com/docs/build-skills#where-codex-loads-local-skills).
|
||||
|
||||
### Windows PowerShell
|
||||
|
||||
Замените путь в `$schemaSource` на путь к своему клону. Junction создаёт ссылку
|
||||
на папку без копирования файлов:
|
||||
Junction позволяет использовать исходные каталоги без копирования:
|
||||
|
||||
```powershell
|
||||
$toolingRepo = 'D:\path\to\openspec-schema'
|
||||
$schemasDir = if ($env:XDG_DATA_HOME) {
|
||||
Join-Path $env:XDG_DATA_HOME 'openspec\schemas'
|
||||
} else {
|
||||
Join-Path $env:LOCALAPPDATA 'openspec\schemas'
|
||||
}
|
||||
$schemaSource = 'D:\path\to\openspec-schema\openspec\schemas\use-case-driven'
|
||||
New-Item -ItemType Directory -Force -Path $schemasDir
|
||||
New-Item -ItemType Junction -Path (Join-Path $schemasDir 'use-case-driven') -Target $schemaSource
|
||||
$skillsDir = Join-Path $HOME '.agents\skills'
|
||||
New-Item -ItemType Directory -Force -Path $schemasDir, $skillsDir
|
||||
New-Item -ItemType Junction -Path (Join-Path $schemasDir 'use-case-driven') `
|
||||
-Target (Join-Path $toolingRepo 'openspec\schemas\use-case-driven')
|
||||
New-Item -ItemType Junction -Path (Join-Path $skillsDir 'task-tracker') `
|
||||
-Target (Join-Path $toolingRepo 'skills\task-tracker')
|
||||
```
|
||||
|
||||
После этого изменения схемы в клоне сразу доступны всем проектам, в которых
|
||||
указано `schema: use-case-driven`. Проверьте подключение из каталога проекта:
|
||||
Команды предполагают, что пути назначения ещё свободны. Если схема уже
|
||||
подключена, создайте только ссылку на скилл. Перед заменой существующей
|
||||
папки/ссылки проверьте её содержимое и источник.
|
||||
|
||||
Проверьте схему из каталога прикладного проекта:
|
||||
|
||||
```sh
|
||||
openspec schema which use-case-driven
|
||||
openspec schema validate use-case-driven
|
||||
```
|
||||
|
||||
Если в проекте есть собственная схема `openspec/schemas/use-case-driven`, она
|
||||
имеет приоритет над пользовательской.
|
||||
Затем убедитесь, что `$task-tracker` появился среди доступных скиллов Codex.
|
||||
Ссылка на скилл не устанавливает MCP и не заполняет проектный `AGENTS.md`.
|
||||
|
||||
Команды создания ссылки предполагают, что путь назначения ещё не занят. Если
|
||||
там уже есть папка или ссылка `use-case-driven`, сначала проверьте её содержимое
|
||||
и источник, прежде чем заменять.
|
||||
Проектная схема `openspec/schemas/use-case-driven` имеет приоритет над
|
||||
пользовательской. Кроме того, схема ссылается на вспомогательные файлы
|
||||
относительно проекта (`validate_format.py`, `patterns/`). Для доступа к ним
|
||||
создайте в проекте ссылку `openspec/schemas/use-case-driven` на ту же общую
|
||||
схему либо адаптируйте пути инструкций. Пользовательская ссылка сама
|
||||
эти проектные пути не создаёт.
|
||||
|
||||
В текущей схеме инструкции также ссылаются на дополнительные файлы по путям
|
||||
относительно проекта, например
|
||||
`openspec/schemas/use-case-driven/validate_format.py` и `patterns/`. Одна
|
||||
пользовательская ссылка делает схему и шаблоны доступными OpenSpec, но не
|
||||
создаёт эти пути внутри каждого проекта. Для таких файлов потребуется отдельная
|
||||
проектная ссылка либо адаптация инструкций к расположению активной схемы.
|
||||
## Переход со старой интеграции
|
||||
|
||||
### Заготовки контекста проекта
|
||||
В прикладных проектах перенесите ключ и метку из старого `context` в
|
||||
`AGENTS.md`, добавьте lifecycle из заготовки и подключите скилл. Удалите
|
||||
старые инструкции трекера из `config.yaml`, включая
|
||||
`operations.archive.guidance`; остальные контекст и правила сохраните.
|
||||
Если схема скопирована в проект вместо ссылки, обновите также её копию.
|
||||
|
||||
Ссылка на пользовательскую схему также не устанавливает `AGENTS.md` или
|
||||
`openspec/context/` в проект-потребитель. Для начальной настройки можно вручную
|
||||
скопировать и адаптировать файлы из
|
||||
[`examples/project-bootstrap/`](examples/project-bootstrap/). Комплект включает
|
||||
инструкции агента, индекс контекста, правила ADR и копию ADR-шаблона. Содержимое
|
||||
индекса и любые дополнительные документы контекста должны соответствовать
|
||||
конкретному проекту. В комплекте нет принятых ADR и описаний бизнес-домена.
|
||||
Существующие ID/URL в proposal сохраняйте до проверенной привязки.
|
||||
Скилл умеет читать прежние ссылки и записывает `task-tracker.yaml` после
|
||||
проверки задачи. Архивным changes без однозначной связи новую задачу
|
||||
автоматически не создаёт.
|
||||
|
||||
## Проверки и ограничения
|
||||
|
||||
## Статус
|
||||
```sh
|
||||
openspec schema validate use-case-driven
|
||||
python3 -m unittest discover -s tests -v
|
||||
```
|
||||
|
||||
Схема находится в стадии доработки. Описаны ещё не все типы функциональных
|
||||
требований и форматы контрактов: например, для FR `[UI]` пока нет подробного
|
||||
паттерна; могут отсутствовать и другие типы. Поэтому схема пока не гарантирует,
|
||||
что при подготовке спецификации будут выявлены все применимые требования — в
|
||||
том числе к безопасности, аудиту и ролевой модели. Эти аспекты нужно явно
|
||||
учитывать при анализе изменения.
|
||||
Тесты `test_task_tracker_archive.py` используют установленный `openspec` CLI
|
||||
во временных каталогах и проверяют сохранение связи и журнала при успешном
|
||||
archive, отказе валидации и конфликте архива. Они не обращаются к трекеру;
|
||||
без CLI пропускаются. Frontmatter скилла можно отдельно проверить
|
||||
`scripts/quick_validate.py` из установленного `skill-creator`.
|
||||
|
||||
Создание, повторная привязка, обновление, закрытие, ошибки MCP и отсутствие
|
||||
конфигурации описаны в скилле. Их внешнее выполнение требует доступного
|
||||
провайдера; инструктивный скилл не даёт программных гарантий исполнения.
|
||||
Для сквозной проверки используйте согласованный тестовый проект, не создавайте
|
||||
тестовые задачи в рабочем проекте без согласования.
|
||||
|
||||
Схема продолжает развиваться: не все типы FR и форматы контрактов имеют
|
||||
подробные паттерны, например FR `[UI]`. Применимые требования безопасности,
|
||||
аудита и ролевой модели нужно явно учитывать при анализе изменения.
|
||||
|
||||
Reference in New Issue
Block a user