Skip to content

Commit 0297202

Browse files
authored
Add commit convention rules to AGENTS.md
Added commit convention rules and examples to AGENTS.md.
1 parent e6084c6 commit 0297202

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,19 @@ Problem definition → small, safe change → change review → refactor — rep
6666
- Don’t ignore failures or warnings.
6767
- Don’t introduce unjustified optimization or abstraction.
6868
- Don’t overuse broad exceptions.
69+
70+
## Commit Convention Rules
71+
72+
- Follow `@commitlint/config-conventional` specification (https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional).
73+
- Format: `<type>[optional scope]: <description>`.
74+
- Allowed types: `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`.
75+
- Type must be lowercase and non-empty.
76+
- Subject must not be empty, not end with period (.), and avoid sentence-case/start-case/pascal-case/upper-case.
77+
- Header max length: 100 characters.
78+
- Body and footer require leading blank line, max line length: 100 characters.
79+
- Breaking changes: use `BREAKING CHANGE:` in footer with blank line before it.
80+
- Examples:
81+
-`fix: resolve memory leak in user service`
82+
-`feat(auth): add OAuth2 integration`
83+
-`Fix: Some Message.` (wrong case, ends with period)
84+
-`random: some change` (invalid type)

0 commit comments

Comments
 (0)