File tree Expand file tree Collapse file tree 1 file changed +17
-7
lines changed
Expand file tree Collapse file tree 1 file changed +17
-7
lines changed Original file line number Diff line number Diff 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
You canβt perform that action at this time.
0 commit comments