Read the full documentation at SemVer
Conventional Commits is a good source for semantic changes.
<tag>(<scope>): <subject>
feat: add hat wobble
┌─── ┌─────────────
│ │
│ └─► Summary in present tense.
│
└───────► Type: See table below
| Type | What | Examples |
|---|---|---|
| feat | New feature for the user | - feat: sending confirmation email on signup - feat(lang): added support for Danish |
| fix | Bug fix for the user | - fix: |
| docs | Changes to the documentation | - docs: documented missing API |
| perf | Performance optimization/enhancemnet | - perf: |
| security | Security enhancements | - security: roll back to package@1.2.3 because of vulnerability in @^1.2.5 - security: Fix to vulnerability in code |
| refactor | Change in production code | - refactor: |
| test | Adding/refactoring tests | - test: |
| chore | - Package upgrade - CI change - Github Workflows - etc... Management in general |
- chore: - chore(deps): updated package@x.y.z -> package@x.y.z |
| BREAKING | Anything that might break existing users code | - BREAKING: |