From c12d6dd7357423c708e390323620f8afa0a816d2 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Thu, 16 Apr 2026 14:00:16 +0200 Subject: [PATCH] docs: expand .rules.md with commit type guidance Clarify which Conventional Commit types trigger releases and must be used for source code only, and map the remaining types to their scope. --- .rules.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.rules.md b/.rules.md index baca98fd..45c23c5b 100644 --- a/.rules.md +++ b/.rules.md @@ -51,6 +51,13 @@ uv run poe e2e-tests - Tests are exempt from docstring rules (`D`), assert warnings (`S101`), and private member access (`SLF001`) - Unused imports are allowed in `__init__.py` files (re-exports) - **Pre-commit hooks**: lint check + type check run automatically on commit +- **Commits**: [Conventional Commits](https://www.conventionalcommits.org/) format. Choose the type based on *what* changed, not just *why*: + - `feat:` / `fix:` / `perf:` / `refactor:` / `style:` — **source code only**; these trigger a release and appear in the changelog + - `test:` — test additions or changes (no release triggered) + - `docs:` — documentation changes; also triggers a doc release on master + - `ci:` — CI/workflow changes + - `chore:` — dependency bumps, tooling, and other housekeeping + - `build:` — build system changes ## Architecture