-
Notifications
You must be signed in to change notification settings - Fork 0
docs: CONTRIBUTING.md для контрибьюторов (XDE-118) #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Участие в разработке `getskillpack/cli` | ||
|
|
||
| Спасибо за интерес к репозиторию официального CLI **`skillget`**. Ниже — минимум, чтобы собрать проект и открыть осмысленный PR; подробные шаги и контекст — в ссылках, без копирования длинных инструкций. | ||
|
|
||
| ## Что почитать в первую очередь | ||
|
|
||
| - **Сборка, переменные окружения, команды:** [docs/QUICKSTART.md](docs/QUICKSTART.md) | ||
| - **Матрица совместимости** (CLI, skillget-manager, registry): [docs/COMPATIBILITY_MATRIX_RU.md](docs/COMPATIBILITY_MATRIX_RU.md) | ||
| - **Индекс документации:** [docs/README.md](docs/README.md) | ||
| - **Обзор репозитория и ссылок на смежные репо:** [README.md](README.md) (разделы *Docs*, *User docs*, *Product repositories*) | ||
| - **Релизы и semver:** [docs/RELEASE.md](docs/RELEASE.md) и [CHANGELOG.md](CHANGELOG.md) | ||
|
|
||
| ## Требования к окружению | ||
|
|
||
| - **Go 1.22+** (см. `go.mod` / `toolchain` в корне). | ||
| - Для работы с npm-обёрткой **`@getskillpack/cli`**: Node.js **18+** (см. [README.md](README.md), раздел *Install*). | ||
|
|
||
| ## Сборка из исходников | ||
|
|
||
| Из корня репозитория: | ||
|
|
||
| ```bash | ||
| go build -o skillget ./cmd/skillget | ||
| ./skillget --help | ||
| ``` | ||
|
|
||
| Детали и настройка registry URL — в [docs/QUICKSTART.md](docs/QUICKSTART.md). | ||
|
|
||
| ### Приватный модуль `skillget-manager` | ||
|
|
||
| Для `go build` / `go test` при необходимости доступа к приватным модулям GitHub org настройте `GOPRIVATE`, `GONOSUMDB` и учётные данные git — чеклист: [docs/BOARD_PAT_QUICK_RU.md](docs/BOARD_PAT_QUICK_RU.md) (в т.ч. § про Go modules). **Не коммитьте** токены и PAT в репозиторий. | ||
|
|
||
| ## Тесты | ||
|
|
||
| То, что гоняет CI по умолчанию (без живого registry): | ||
|
|
||
| ```bash | ||
| go test -mod=vendor -short ./... | ||
| ``` | ||
|
|
||
| Опционально — интеграционные / smoke-сценарии против production registry, переменные `SKIP_SKILLGET_REGISTRY_INTEGRATION`, `SKILLGET_SMOKE_INSTALL_SPEC`: полное описание в [docs/QUICKSTART.md](docs/QUICKSTART.md) (раздел про тесты). | ||
|
|
||
| ## Issues и pull requests | ||
|
|
||
| 1. **Issue** — опишите воспроизведение, ожидаемое и фактическое поведение, версию CLI (`skillget -V`) и при необходимости URL registry. | ||
| 2. **PR** — нацеливайте на ветку **`main`**, одна логическая тема на PR; для пользовательски заметных изменений обновляйте [CHANGELOG.md](CHANGELOG.md) (см. [docs/RELEASE.md](docs/RELEASE.md)). | ||
| 3. Агентам Paperclip и автоматизации в org **getskillpack**: гигиена PAT, ветки и push — [docs/AGENT_GITHUB_REPO_WORKFLOW_RU.md](docs/AGENT_GITHUB_REPO_WORKFLOW_RU.md). | ||
|
|
||
| Контракт registry и стабильность API — в репозитории [`getskillpack/registry`](https://github.com/getskillpack/registry); клиентский контракт — в [`getskillpack/skillget-manager`](https://github.com/getskillpack/skillget-manager) (`docs/REGISTRY_CLIENT_CONTRACT.md`), без дублирования здесь. | ||
|
|
||
| ## Безопасность | ||
|
|
||
| Сообщения об уязвимостях — по [SECURITY.md](SECURITY.md). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Команда тестов здесь не полностью совпадает с тем, что запускает CI: в workflow добавлен
-count=1(и CI также отдельно делаетgo build/go vet). Чтобы текст был точным, обновите команду/формулировку (например, добавить-count=1или уточнить, что это сокращённый вариант).