Skip to content

Commit 06f14a4

Browse files
authored
docs: expand .rules.md with commit type guidance (#1850)
Clarifies which Conventional Commit types (`feat`/`fix`/`perf`/`refactor`/`style`) trigger a release and must be used for source code only, and maps the remaining types (`test:`, `docs:`, `ci:`, `chore:`, `build:`) to their correct scope.
1 parent 306dc46 commit 06f14a4

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

.rules.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,13 @@ Note: `uv run poe unit-tests` first runs tests marked `@pytest.mark.run_alone` i
5151
- **Docstrings**: Google format (enforced by Ruff)
5252
- **Type checker**: ty (Astral's type checker), target Python 3.10
5353
- **Async mode**: pytest-asyncio in `auto` mode (no need for `@pytest.mark.asyncio`)
54-
- **Commit format**: Conventional Commits (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`, etc.)
54+
- **Commits**: [Conventional Commits](https://www.conventionalcommits.org/) format. Choose the type based on *what* changed, not just *why*:
55+
- `feat:` / `fix:` / `perf:` / `refactor:` / `style:`**source code only**; these trigger a release and appear in the changelog
56+
- `test:` — test additions or changes (no release triggered)
57+
- `docs:` — documentation changes; also triggers a doc release on master
58+
- `ci:` — CI/workflow changes
59+
- `chore:` — dependency bumps, tooling, and other housekeeping
60+
- `build:` — build system changes
5561

5662
## Architecture
5763

0 commit comments

Comments
 (0)