Skip to content

Commit 326139f

Browse files
committed
docs: add git commit conventions
1 parent 89ad600 commit 326139f

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Git Commit Rules
2+
3+
When committing code, you MUST follow these rules:
4+
5+
## Commit message format
6+
7+
Use Conventional Commits:
8+
9+
`<type>(<scope>): <subject>`
10+
11+
Allowed types:
12+
13+
- feat
14+
- fix
15+
- docs
16+
- style
17+
- refactor
18+
- perf
19+
- test
20+
- build
21+
- ci
22+
- chore
23+
24+
Examples:
25+
26+
feat(auth): add oauth login support
27+
28+
fix(order): prevent duplicate payment processing
29+
30+
Rules:
31+
32+
- subject must be lowercase
33+
- subject max length 72 chars
34+
- no period at the end
35+
- use imperative mood
36+
- commit message must be written in English
37+
38+
Before committing:
39+
40+
- run git diff --cached
41+
- verify commit message format

0 commit comments

Comments
 (0)