Maksim Totmin
c398045664
forge-toolkit: хелперы для разработки MCP-серверов на Go. - toolkit: args/schema/result/env/probe/server - toolkit/validate: валидаторы синтаксиса - configreload: live-reload конфига по контент-хэшу - docs: ARCHITECTURE, quickstart, mcp-contract - template/ и examples/hello-tool/ - CI (Gitea Actions), лицензия Apache-2.0
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# Contributing
|
|
|
|
Спасибо за интерес к forge-toolkit! Ниже — как предложить изменение.
|
|
|
|
## Окружение
|
|
|
|
- Go 1.27+.
|
|
- `golangci-lint` v2.13.2 (или новее в пределах v2).
|
|
|
|
```bash
|
|
git clone https://git.totmin.ru/en2zmax/forge-toolkit.git
|
|
cd forge-toolkit
|
|
make test # go test -race ./...
|
|
make lint # golangci-lint + gofmt
|
|
```
|
|
|
|
## Требования к изменениям
|
|
|
|
- Небольшие, сфокусированные PR; один смысловой блок на PR.
|
|
- Новый код сопровождается тестами; `make test` и `make lint` должны быть зелёными.
|
|
- Публичный API — с doc-комментариями; комментарии по-русски (как в проекте).
|
|
- **Границы тулкита неизменны:** только домен-агностичные хелперы и зависимости
|
|
stdlib + `go-sdk` (+ `yaml.v3`/`toml` в `validate`). Проверяется `make toolkit-deps`.
|
|
Доменная логика и «на будущее» расширения не принимаются.
|
|
- Изменения поведения — с записью в [`CHANGELOG.md`](CHANGELOG.md).
|
|
|
|
## Коммиты
|
|
|
|
Осмысленный заголовок в стиле Conventional Commits, например:
|
|
|
|
```
|
|
feat(args): поддержать GetFloat
|
|
fix(probe): не выполнять действие на probe
|
|
docs: уточнить контракт результата
|
|
```
|
|
|
|
## Лицензия вклада
|
|
|
|
Отправляя PR, вы соглашаетесь на распространение вклада под
|
|
[Apache-2.0](LICENSE).
|