Skip to content

Commit 326e833

Browse files
committed
docs: Mandate conventional commits for automated releases
Update AGENTS.md to require conventional commit format since the release automation (git-cliff + cargo-dist) depends on parsing commit types for changelog generation and version bump detection.
1 parent 076dbc6 commit 326e833

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -133,22 +133,22 @@ mcp__rust-lsp__completion "crates/slipstreamd/src/routes.rs" 42 20
133133
- Never ignore errors - propagate or handle explicitly
134134

135135
## Commit Messages
136-
- Write clear, descriptive commit messages in plain English
137-
- Do NOT use conventional commits, semantic commits, or any commit prefixes (no "feat:", "fix:", "refactor:", etc.)
138-
- Focus on WHAT changed and WHY, not the type of change
136+
- **MUST use conventional commits** - automated releases depend on them
137+
- Format: `<type>: <description>` where type is one of: feat, fix, refactor, chore, docs, test, perf, style
138+
- Include `bump:major`, `bump:minor`, or `bump:patch` in PR title/body for version bumps
139139
- First line should be a clear summary (50-72 chars recommended)
140140
- Use the body for detailed explanation if needed
141-
- Reference issue IDs when relevant (e.g., "Closes: slipstream-24")
141+
- Reference issue IDs when relevant (e.g., "Closes: #123")
142142

143143
Good examples:
144-
- "Split search into dedicated Searcher service"
145-
- "Add reranking provider for DeepInfra Qwen3-Reranker"
146-
- "Fix flaky test by increasing tolerance for timing variance"
144+
- "feat: Add reranking provider for DeepInfra Qwen3-Reranker"
145+
- "fix: Stabilize online prediction scoring and tests"
146+
- "refactor: Split search into dedicated Searcher service"
147147

148148
Bad examples:
149-
- "refactor(embedding): Split search into dedicated Searcher service"
150-
- "feat: add reranking provider"
151-
- "fix: flaky test"
149+
- "Split search into dedicated Searcher service" (missing type)
150+
- "Add reranking provider" (missing type prefix)
151+
- "flaky test fix" (missing type prefix)
152152

153153
## SUPER IMPORTANT
154154
- Do NOT run git commands that can result in loss of work unilaterally. ALWAYS get approval from the user for git checkout/reset/restore/revert/...

0 commit comments

Comments
 (0)