Skip to content

Commit 7ea4493

Browse files
d135-1r43claude
andcommitted
docs: πŸ“ Update commit convention for semantic versioning
- Change format to type(scope): emoji description - Ensure compatibility with release-please parser - Add breaking change examples - Clarify version bump rules Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 5dcb761 commit 7ea4493

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

β€ŽCLAUDE.mdβ€Ž

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,23 @@ class ExampleTest {
130130

131131
## Commit Message Convention
132132

133-
Use official GitMoji commit message convention, e.g.
134-
- πŸ“ `(docs):` - Documentation changes
135-
- 🎨 `(design):` - UI/UX changes
136-
- πŸ‘· `(ci):` - CI/CD changes
137-
- ✨ `(feat):` - New features
138-
- πŸ› `(fix):` - Bug fixes
139-
- ♻️ `(refactor):` - Code refactoring
133+
Use conventional commits with GitMoji for semantic versioning compatibility:
134+
135+
**Format:** `type(scope): emoji description`
136+
137+
Examples:
138+
- `docs: πŸ“ Update API documentation` - Documentation changes
139+
- `design: 🎨 Improve button styling` - UI/UX changes
140+
- `ci: πŸ‘· Add release workflow` - CI/CD changes
141+
- `feat: ✨ Add QR code generation` - New features (minor version bump)
142+
- `fix: πŸ› Correct URL validation` - Bug fixes (patch version bump)
143+
- `refactor: ♻️ Simplify database queries` - Code refactoring
144+
145+
**Breaking changes:** Add `!` after type or `BREAKING CHANGE:` in footer for major version bumps
146+
- `feat!: ✨ Change API response format`
147+
- Or in commit body: `BREAKING CHANGE: API now returns different format`
148+
149+
This format ensures compatibility with automated semantic versioning via release-please
140150

141151
## Best Practices
142152

0 commit comments

Comments
Β (0)