Skip to content

Commit 8b75b88

Browse files
committed
docs(git-workflow): update commit message formatting rules
- add best practices section enforcing lowercase text, bulleted change lists, and succinct descriptions - update commit types and examples to use lowercase formatting
1 parent 4648415 commit 8b75b88

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

.agents/skills/git-workflow/SKILL.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,42 +15,50 @@ You are a Git workflow assistant. Help users with commits, branches, and pull re
1515

1616
For commit message generation and validation, use `get_skill_script("git-workflow", "commit_message.py")`.
1717

18+
### Best Practices & Rules
19+
- **body format:** use list items instead of sentences to explain changes.
20+
- **uniqueness:** each list item should describe something unique to avoid repetition.
21+
- **casing:** all text in the commit message must be lowercase except when referencing code that uses different cases.
22+
- **subject line:** use imperative mood (e.g., "add" instead of "added"), keep it concise (under 72 chars), and do not end with a period.
23+
- **structure:** always separate the subject from the body with a blank line, and wrap body lines at ~72 characters.
24+
1825
### Format
1926
```
2027
<type>(<scope>): <subject>
2128
22-
<body>
29+
- <unique change description>
30+
- <another unique change description>
2331
2432
<footer>
2533
```
2634

2735
### Types
28-
- **feat**: New feature
29-
- **fix**: Bug fix
30-
- **docs**: Documentation only
31-
- **style**: Formatting, no code change
32-
- **refactor**: Code change that neither fixes a bug nor adds a feature
33-
- **perf**: Performance improvement
34-
- **test**: Adding or updating tests
35-
- **chore**: Maintenance tasks
36+
- **feat**: new feature
37+
- **fix**: bug fix
38+
- **docs**: documentation only
39+
- **style**: formatting, no code change
40+
- **refactor**: code change that neither fixes a bug nor adds a feature
41+
- **perf**: performance improvement
42+
- **test**: adding or updating tests
43+
- **chore**: maintenance tasks
3644

3745
### Examples
3846
```
39-
feat(auth): add OAuth2 login support
47+
feat(auth): add oauth2 login support
4048
41-
Implemented OAuth2 authentication flow with Google and GitHub providers.
42-
Added token refresh mechanism and session management.
49+
- implement `OAuth2` authentication flow with google and github providers
50+
- add token refresh mechanism and session management
4351
44-
Closes #123
52+
closes #123
4553
```
4654

4755
```
4856
fix(api): handle null response from external service
4957
50-
Added null check before processing response data to prevent
51-
NullPointerException when external service returns empty response.
58+
- add null check before processing response data
59+
- prevent `NullPointerException` when external service returns empty response
5260
53-
Fixes #456
61+
fixes #456
5462
```
5563

5664
## Branch Naming

0 commit comments

Comments
 (0)