Andrew Gazelka
12/06/2024, 12:13 AMtype(optional-scope): description
[optional body]
[optional footer]
Types We're Supporting
- `feat`: New features
- `fix`: Bug fixes
- `docs`: Documentation changes
- `test`: Adding or updating tests
- `ci`: CI/CD related changes
- `refactor`: Code refactoring
- `perf`: Performance improvements
- `chore`: Maintenance tasks
- `revert`: Reverting changes
Breaking Changes
For breaking changes, add a ! after the type/scope:
feat!: remove deprecated API
Examples
Good commit messages:
feat(parser): add ability to parse arrays
fix(database): resolve connection timeout
docs: update API
perf(runtime): improve query performance by 50%
What's Changing?
1. PR titles must follow conventional commit format
2. Breaking changes must now use ! to follow conventional commit syntax
Tools and Automation
- We've updated our PR validation to enforce conventional commit format
- Release notes will be automatically categorized based on commit types
- Labels are automatically applied based on the commit type prefix
Resources 📚
- Official specification: https://www.conventionalcommits.org/
- Quick reference guide: https://www.conventionalcommits.org/en/v1.0.0/#summary
- Tools & integrations: https://www.conventionalcommits.org/en/about/
- VS Code extension: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits