- commit format: Conventional Commits (all six *-standards) - branches/deploy: feature branches from main; release-* -> stage, tag v* -> prod (all six *-standards) - jira-workflow: statuses To Do -> In Progress -> Review -> Done; who moves status when; MR link + status transition policy; comment guidance - key-prefix list stays TODO (unknown project prefixes) Verified: no leftover commit-format TODOs, deploy convention in all 6, skills still load via pi.
3.9 KiB
3.9 KiB
name, description
| name | description |
|---|---|
| go-standards | Используй при написании, ревью и проверке кода на Go в наших сервисах — структура сервиса, запуск линтеров и тестов, формат коммитов и merge request. Применяй всегда, когда пишешь или правишь Go-код, готовишь MR, а также в командах /bugfix, /feature и /review. |
Стандарты Go
Наш основной стек — Go. Скилл описывает, как писать, проверять и оформлять код.
Реалистичные общепринятые дефолты приведены ниже; то, что специфично для компании,
помечено TODO — уточняй, не выдумывай.
Структура сервиса
Ориентир (уточняется под компанию):
cmd/<service>/main.go # точка входа
internal/ # приватный код сервиса
<domain>/ # доменные пакеты
pkg/ # переиспользуемый публичный код (если есть)
api/ # спецификации API (proto/openapi)
Линтеры
- Форматирование:
gofmt -l -w .иgoimports -w .— код должен быть отформатирован. - Статический анализ:
go vet ./.... - Основной линтер: golangci-lint —
golangci-lint run ./.... Набор линтеров задаётся в.golangci.ymlв корне репозитория.
Тесты
- Прогон всех тестов:
go test ./.... - С гонками и покрытием:
go test -race -cover ./.... - Требования к покрытию и обязательные виды тестов:
<!-- TODO: пороги покрытия, интеграционные тесты -->. - Именование:
TestXxx, табличные тесты приветствуются.
Коммиты и MR
- Формат коммитов: Conventional Commits (
feat:,fix:,chore:,docs:,refactor:,test:…). - Ветки и деплой: фича-ветки — от
main(в имя ветки желательно включать ключ тикета). Деплой управляется ветками/тегами: веткаrelease-*→ раскатка на stage; тегv*→ раскатка в прод. Веткиrelease-*и тегиv*без необходимости не пушь —permission-gateпереспросит. - MR обязателен (см. корпоративные правила из контекста сессии). Прямой push в защищённые
ветки запрещён — расширение
permission-gateдополнительно переспросит. - Описание MR: что и зачем изменено, как проверено (линтеры + тесты), ссылка на тикет
(см. скилл
jira-workflow). - Перед MR прогони линтеры и тесты — всё должно быть зелёным.
Чек-лист перед MR
gofmt/goimportsбез измененийgo vet ./...чистоgolangci-lint run ./...чистоgo test ./...(или-race) зелёные- есть тесты на новую логику / фикс
- нет секретов и закоммиченных
.env - описание MR со ссылкой на тикет