diff --git a/README.md b/README.md index 0345981..d9fe6c6 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ PI_KIT_PROFILE=backend curl -fsSL https://git.codelab.vc/ai/pi-kit/raw/branch/st ### Профили и скилы -Общее для всех: команды `/bugfix /feature /review /rfc /kit-config /kit-doctor /kit-help`, guardrails, скилы -`jira-workflow`, `repo-map`, `docs-map`, и публичные `grill-me`, `grill-with-docs`, +Общее для всех: команды `/bugfix /feature /review /rfc /kit-config /kit-doctor /kit-help /mcp-status`, +guardrails, скилы `jira-workflow`, `repo-map`, `docs-map`, и публичные `grill-me`, `grill-with-docs`, `code-review`, `diagnosing-bugs`. Дополнительно по профилю: | Профиль | Языковые стандарты | Доп. публичные скилы | @@ -70,20 +70,24 @@ pi update --extensions |---|---| | `/bugfix <тикет>` | Прочитать тикет → воспроизвести → падающий тест → починить → линтеры/тесты → описание MR | | `/feature <тикет>` | Прочитать тикет → план в `PLAN.md` и остановка на согласование → реализация с тестами | -| `/review [фокус]` | Ревью текущего диффа по стандартам Go (с фокусом, если задан) | +| `/review [фокус]` | Ревью текущего диффа по стандартам кода профиля (с фокусом, если задан) | | `/rfc <тема>` | Черновик RFC по типовому шаблону | | `/kit-config` | Показать действующие корпоративные значения и их источник (local/remote) | -| `/kit-doctor` | Health-check окружения (node, версия/канал, конфиг, env, токены) | +| `/kit-doctor` | Health-check окружения (node, версия/канал, конфиг, env, токены; подсветит незаполненные поля) | | `/kit-help` | Каталог возможностей: команды, скилы, guardrails | +| `/mcp-status` | Статус MCP-серверов (Jira/Confluence/GitLab; по умолчанию выключены — см. `docs/mcp.md`) | ### Скиллы Подключаются автоматически, когда задача им соответствует: -- **jira-workflow** — работа с трекером (чтение тикетов, комментарии, ссылки на MR). -- **repo-map** — как ориентироваться в наших репозиториях. +- **jira-workflow** — работа с трекером (чтение тикетов, комментарии, ссылки и создание MR). +- **repo-map** — как ориентироваться в наших репозиториях (если карта не заполнена — скилл + скажет об этом и не будет выдумывать). - **docs-map** — как искать и куда писать документацию. -- **go-standards** — стандарты Go: структура сервиса, линтеры, тесты, коммиты/MR. +- **Языковые стандарты** — `-standards` для `go`/`rust`/`python`/`typescript`/`kotlin`/`swift`: + структура, линтеры, тесты, коммиты/MR. Подключаются **по профилю** (см. таблицу выше), + промпты команд ссылаются на них обобщённо (`-standards`), а не на конкретный язык. ### Guardrails (встроенная защита) @@ -118,8 +122,10 @@ pi-kit/ │ ├── mcp-bridge.ts # Jira/Confluence/GitLab MCP (по умолч. выкл.) │ ├── kit-cli.ts # /kit-doctor, /kit-help │ └── lib/ # общий код (secrets, audit, company-config) -├── skills/ # SKILL.md-скиллы (jira-workflow/repo-map/docs-map/go-standards) +├── skills/ # SKILL.md-скиллы (jira-workflow/repo-map/docs-map + -standards) ├── prompts/ # шаблоны команд (/bugfix, /feature, /review, /rfc) +├── test/ # guardrails.test.ts (node) + shell.test.sh (create-mr.sh) +├── docs/mcp.md # документация MCP-интеграций └── install.sh # bootstrap для новых сотрудников ``` @@ -155,6 +161,9 @@ pi-kit/ - Тексты формулировок (не значения) правятся в `extensions/company-context.md` между `{{плейсхолдерами}}` — можно доверить не-программистам. - Проверить действующие значения и их источник: `/kit-config`. +- Пока какие-то поля не заполнены (`TODO`/пусто) — `/kit-doctor` предупредит, а скиллы + `repo-map`/`docs-map` не будут выдумывать и попросят уточнить. Заполнение — шаг к + реальной полезности кита: без карты репозиториев скиллы работают «вхолостую». ### Как добавить скилл @@ -197,7 +206,7 @@ pi-kit/ - Пути к файлам пакета резолвь через `import.meta.url`, не через `cwd`. - Общий код расширений — в `extensions/lib/*.ts` (не `index.ts` → Pi не грузит как расширение). - Pi-библиотеки — только в `peerDependencies` (`"*"`), не бандлить. -- Guardrails/секреты покрыты тестами — `npm test` (`test/guardrails.test.ts`). +- Guardrails/секреты покрыты тестами — `npm test` (`test/guardrails.test.ts` + `test/shell.test.sh`). ### Релизы