[GITHUB] commit conventional - fourslickz/notes GitHub Wiki
- type: The kind of change (see list below)
- scope: (optional) Area of the codebase the change affects
- summary: A concise description of the change
- body: (optional) More detailed explanation (wrapped at 72 characters)
- footer: (optional) Notes for breaking changes or issue references
🔧 Allowed Types
| Type |
Description |
feat |
A new feature |
fix |
A bug fix |
docs |
Documentation only changes |
style |
Code style changes (white-space, formatting, etc.) |
refactor |
Code refactoring without adding features/fixes |
perf |
Performance improvements |
test |
Adding or updating tests |
build |
Changes to build system or external dependencies |
ci |
CI configuration changes (GitHub Actions, etc.) |
chore |
Misc changes (e.g., version bump, cleanup) |
revert |
Reverting a previous commit |
✍️ Examples
feat(auth): add JWT authentication middleware
fix(api): handle null pointer in user data fetch
docs(readme): update usage section with CLI examples
style(css): fix spacing and alignment in dashboard
refactor(user): split service into smaller modules
test(login): add unit tests for login endpoint
build(docker): update base image to node:18-alpine
ci(github): add GitHub Actions for test workflow
chore(deps): upgrade all npm dependencies
revert: feat(auth): add JWT authentication middleware