Files
pi-kit/skills/python-standards/SKILL.md
Aleksey Shakhmatov c2cdf40cad docs(skills): fill cross-cutting Git/Jira conventions
- 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.
2026-07-16 13:10:34 +03:00

3.4 KiB
Raw Blame History

name, description
name description
python-standards Используй при написании, ревью и проверке кода на Python в наших сервисах — структура проекта, запуск ruff/mypy, тесты, формат коммитов и merge request. Применяй всегда, когда пишешь или правишь Python-код, готовишь MR, а также в командах /bugfix, /feature и /review для Python-репозиториев.

Стандарты Python

Один из наших языков — Python. Ниже — общепринятые дефолты экосистемы; специфичное для компании помечено TODO — уточняй, не выдумывай.

Структура

Ориентир (уточняется под компанию):

pyproject.toml
src/<package>/          # src-layout
  __init__.py
tests/

Линтеры и форматирование

  • Линтер + форматтер: ruffruff check . и ruff format --check . (локально ruff format .). Конфиг — в pyproject.toml ([tool.ruff]).
  • Типы: mypymypy . (конфиг [tool.mypy]).

Тесты

  • Прогон: pytestpytest (с покрытием — pytest --cov).
  • Требования к покрытию / обязательные виды тестов: <!-- TODO -->.

Окружение и зависимости

  • Менеджер зависимостей и lock: <!-- TODO: poetry / uv / pip-tools --> — lock коммитим.
  • Виртуальное окружение — обязательно; глобально пакеты не ставим.

Коммиты и MR

  • Формат коммитов: Conventional Commits (feat:, fix:, chore:, docs:, refactor:, test: …).
  • Ветки и деплой: фича-ветки — от main (в имя ветки желательно включать ключ тикета). Деплой управляется ветками/тегами: ветка release-* → раскатка на stage; тег v* → раскатка в прод. Ветки release-* и теги v* без необходимости не пушь — permission-gate переспросит.
  • MR обязателен (см. корпоративные правила из контекста сессии). Прямой push в защищённые ветки запрещён — расширение permission-gate дополнительно переспросит.
  • Перед MR: ruff check ., ruff format --check ., mypy ., pytest — всё зелёное.
  • Описание MR: что и зачем, как проверено, ссылка на тикет (скилл jira-workflow).

Чек-лист перед MR

  • ruff check . чисто
  • ruff format --check . чисто
  • mypy . чисто
  • pytest зелёные, есть тесты на новую логику / фикс
  • нет секретов и закоммиченных .env
  • описание MR со ссылкой на тикет