Conventional Commits is a simple convention for commit messages that makes them human- and machine-readable, helping with versioning, changelogs, and collaboration.
Format: <type>(<scope>?): <short description>
🚀 Commit Types:
| Type | Description | Example |
|---|---|---|
| Feature | Add a new feature | feat(ui): add search bar |
| Bug Fix | Fix a bug | fix(auth): resolve login crash |
| Hot Fix | Apply a hotfix | hotfix(ui): address button alignment |
| Documentation | Update documentation only | docs(readme): add setup guide |
| Style | Code style change, no logic impact | style: format with Prettier |
| Refactor | Improve code without adding features/fixes | refactor(api): simplify error handling |
| Perf | Improve performance | perf(db): optimize query execution |
| Test | Add or update tests | test: add unit tests for utils |
| Build | Changes to build system/dependencies | build: update webpack config |
| CI/CD | Update CI/CD pipelines or scripts | ci(github): add test workflow |
| Chore | Maintenance tasks, no src/test changes | chore(deps): bump axios to v1.7 |
| Revert | Undo a previous commit | revert: restore old auth flow |
Add (!) for incompatible updates.
eg: feat!: remove deprecated endpoints