docs: CONTRIBUTING.md for contributors (PR, API schema, runbooks) - #5
docs: CONTRIBUTING.md for contributors (PR, API schema, runbooks)#5remdev wants to merge 1 commit into
Conversation
Add Russian contributor guide: canonical API docs, runbook links, ecosystem matrix and skillget-manager contract, embed note for registry-api.md, and agent workflow reference. Co-Authored-By: Paperclip <noreply@paperclip.ing> Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
Adds a Russian CONTRIBUTING.md to standardize contributor guidance for the registry repository (build/test instructions, API contract update flow, PR hygiene, and links to operational runbooks and ecosystem docs).
Changes:
- Introduces
CONTRIBUTING.md(RU) with contributor workflow, build/tests, and pointers to canonical API docs. - Documents where API contract lives (
docs/registry-api.md/ embedded docs) and how to keep related docs in sync. - Adds links to ops runbooks and cross-repo contributor guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 2. **PR** — ветка **`main`**, одна логическая тема на PR; пользовательски заметные изменения поведения API сопровождайте обновлением `docs/registry-api.md` (и связанных доков), без копирования runbook-прозы из ops-документов. | ||
| 3. Агентам Paperclip и автоматизации в org **getskillpack**: гигиена PAT, ветки и push — [AGENT_GITHUB_REPO_WORKFLOW_RU.md](https://github.com/getskillpack/cli/blob/main/docs/AGENT_GITHUB_REPO_WORKFLOW_RU.md). | ||
|
|
||
| Смежные репозитории: пользовательский CLI — [`getskillpack/cli`](https://github.com/getskillpack/cli); библиотека ядра установки — [`getskillpack/skillget-manager`](https://github.com/getskillpack/skillget-manager). |
There was a problem hiding this comment.
Упоминание getskillpack/skillget-manager как смежного репозитория конфликтует с docs/PUBLIC_ECOSYSTEM.md (skillget-manager retired/removed). Нужно обновить список смежных репозиториев на актуальные.
| Смежные репозитории: пользовательский CLI — [`getskillpack/cli`](https://github.com/getskillpack/cli); библиотека ядра установки — [`getskillpack/skillget-manager`](https://github.com/getskillpack/skillget-manager). | |
| Смежные репозитории: пользовательский CLI — [`getskillpack/cli`](https://github.com/getskillpack/cli). |
| ## Что почитать в первую очередь | ||
|
|
||
| - **Корневой обзор, сборка, переменные окружения:** [README.md](README.md) | ||
| - **Канонический HTTP API (`/api/v1`):** [docs/registry-api.md](docs/registry-api.md) — же содержимое отдаётся с живого инстанса как `GET /docs/registry-api` |
There was a problem hiding this comment.
В строке про docs/registry-api.md пропущено слово: сейчас «— же содержимое…», по смыслу должно быть «— то же содержимое…» (или переформулировать).
| - **Канонический HTTP API (`/api/v1`):** [docs/registry-api.md](docs/registry-api.md) — же содержимое отдаётся с живого инстанса как `GET /docs/registry-api` | |
| - **Канонический HTTP API (`/api/v1`):** [docs/registry-api.md](docs/registry-api.md) — то же содержимое отдаётся с живого инстанса как `GET /docs/registry-api` |
|
|
||
| ## Требования к окружению | ||
|
|
||
| - **Go 1.22+** (см. `go.mod` / `toolchain` в корне). |
There was a problem hiding this comment.
Упоминание «go.mod / toolchain» не соответствует репозиторию: в go.mod есть только директива go 1.22, но нет toolchain. Либо добавьте toolchain в go.mod, либо уберите/уточните ссылку на него в CONTRIBUTING.
| - **Go 1.22+** (см. `go.mod` / `toolchain` в корне). | |
| - **Go 1.22+** (см. `go.mod` в корне репозитория). |
| - **Матрица совместимости** (CLI, skillget-manager, registry): [COMPATIBILITY_MATRIX_RU.md](https://github.com/getskillpack/cli/blob/main/docs/COMPATIBILITY_MATRIX_RU.md) | ||
| - **Клиентский контракт менеджера к реестру:** [REGISTRY_CLIENT_CONTRACT.md](https://github.com/getskillpack/skillget-manager/blob/main/docs/REGISTRY_CLIENT_CONTRACT.md) | ||
| - **Трассировка требований и тикетов:** [ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md](https://github.com/getskillpack/cli/blob/main/docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md) |
There was a problem hiding this comment.
Здесь есть ссылки/упоминания getskillpack/skillget-manager, но в docs/PUBLIC_ECOSYSTEM.md указано, что этот репозиторий удалён и не должен фигурировать как активная зависимость. Нужна замена ссылок на актуальный источник (скорее всего getskillpack/cli) и обновление формулировки про матрицу совместимости.
|
|
||
| 1. Обновите **[docs/registry-api.md](docs/registry-api.md)** — он **встроен** в бинарь (`embed_docs.go`) и отдаётся как документация с сервера. | ||
| 2. При необходимости синхронизируйте [API.md](API.md), [README.md](README.md) и связанные указатели в `docs/`. | ||
| 3. Если меняется поведение, видимое клиентам CLI/менеджера, проверьте [REGISTRY_CLIENT_CONTRACT.md](https://github.com/getskillpack/skillget-manager/blob/main/docs/REGISTRY_CLIENT_CONTRACT.md) и при необходимости **отдельный PR** в [`getskillpack/skillget-manager`](https://github.com/getskillpack/skillget-manager); матрицу совместимости — в [`getskillpack/cli`](https://github.com/getskillpack/cli). |
There was a problem hiding this comment.
Этот пункт снова ссылается на getskillpack/skillget-manager, который помечен как удалённый/retired в docs/PUBLIC_ECOSYSTEM.md. Стоит заменить инструкцию на актуальный репозиторий/документ (например, getskillpack/cli) и убрать рекомендацию делать PR в удалённый репозиторий.
Summary
Adds
CONTRIBUTING.md(RU) for contributors: canonical HTTP contract (docs/registry-api.md+ embed note), build/tests, PR hygiene, links to ops runbooks (PUBLIC_REGISTRY_RUNBOOK,REFERENCE_REGISTRY_OPERATIONS_RU), compatibility matrix, skillget-manager client contract, and agent GitHub workflow doc.Context
Paperclip XDE-120 — aligns with CONTRIBUTING style from
getskillpack/cliandgetskillpack/skillget-manager.No runtime/code changes.