Skip to content

Commit 1022d40

Browse files
StarefossenCopilot
andcommitted
docs: add conventional commit and git-cliff notes to AGENTS.md
Document the CLI commit message conventions and auto-generated release notes workflow in the agents guide. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 00939d3 commit 1022d40

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,27 @@ The `cnctl` CLI lives in `cli/` as a standalone Cargo project. It uses mise for
343343
- **Build:** `cd cli && mise run build` - Builds release binary.
344344
- **Clean:** `cd cli && mise run clean` - Removes build artifacts.
345345

346+
##### Commit Messages & Release Notes
347+
348+
CLI release notes are **auto-generated** from commit messages using [git-cliff](https://git-cliff.org/) (configured in `cli/cliff.toml`). All commits touching `cli/` **must** use [Conventional Commits](https://www.conventionalcommits.org/) format:
349+
350+
- `feat:` / `feat(scope):` — new features (included in release notes)
351+
- `fix:` — bug fixes (included)
352+
- `perf:` — performance improvements (included)
353+
- `refactor:` — code refactoring (included)
354+
- `docs:` — documentation changes (included)
355+
- `chore:`, `style:`, `ci:`, `test:`, `build(deps):` — excluded from release notes
356+
357+
Examples:
358+
359+
```
360+
feat(sponsors): add email functionality with template support
361+
fix: handle missing conference ID in sponsor lookup
362+
refactor: extract shared email builder into helper module
363+
```
364+
365+
The release workflow (`cli/.github/workflows/release.yml`) runs git-cliff with `--unreleased` to generate the body for each GitHub Release. Tags use date-based versioning: `YYYY.MM.DD-<shortsha>`.
366+
346367
## Code Organization & Refactoring
347368

348369
### Component Structure

0 commit comments

Comments
 (0)