1
# Commit Conventions
2
3
Standing rules for commit messages (Conventional Commits), branch naming, and PR
4
descriptions. Keeps git history searchable by type/scope and makes PRs reviewable
5
without reading the full diff first.
6
7
## When to use
8
9
- Load into any repo that wants a consistent, machine-parseable commit history (e.g.
10
  for automated changelog generation — pairs well with `changelog-generator`).
11
- Teams standardizing on Conventional Commits for semantic-release / automated
12
  versioning tooling.
13
- Solo projects that still want a searchable history months later.
14
15
## Install
16
17
```bash
18
npx openagents-cli add openagents/commit-conventions
19
```
20
21
| Runtime | Installed to |
22
|---|---|
23
| `claude-code` | `.claude/skills/commit-conventions/` |
24
| `cursor` | `.cursor/rules/commit-conventions/` |
25
| `codex` | `.codex/skills/commit-conventions/` |
26
| `generic` | `.openagents/commit-conventions/` |
27
28
## Inputs
29
30
None — static rules, no runtime parameters.
31
32
## Example run
33
34
```
35
> Commit these changes following our conventions.
36
```
37
38
The agent classifies the change (`fix`, `feat`, etc.), writes an imperative-mood
39
summary under ~72 chars, adds a body explaining why when non-obvious, and — if opening
40
a PR — fills out `templates/pr.md` with a scannable summary, change list, and testing
41
notes.
42
43
## Files
44
45
- `RULES.md` — commit message format, types table, branch naming, examples (entry
46
  point).
47
- `templates/pr.md` — the PR description template and guidance on filling it out.
48
49
## Limitations
50
51
- Conventions only — does not install a commit-lint hook or enforce the format
52
  automatically; pair with `commitlint`/a pre-commit hook for hard enforcement.
53
- Assumes a squash-or-rebase workflow where commit type matters for changelog
54
  generation; teams doing merge commits with heavy commit-squashing later may care more
55
  about PR titles than individual commit messages.
56