From e9180b6b614d40ef07cd12f3715fdcc7b46476ce Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Thu, 16 Apr 2026 13:58:30 +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 | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.rules.md b/.rules.md index 180c3d10d5..ee4730c70f 100644 --- a/.rules.md +++ b/.rules.md @@ -51,7 +51,13 @@ Note: `uv run poe unit-tests` first runs tests marked `@pytest.mark.run_alone` i - **Docstrings**: Google format (enforced by Ruff) - **Type checker**: ty (Astral's type checker), target Python 3.10 - **Async mode**: pytest-asyncio in `auto` mode (no need for `@pytest.mark.asyncio`) -- **Commit format**: Conventional Commits (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`, etc.) +- **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