This website follows Conventional Commits
Commit message will be checked using husky and commit lint, you can't commit if not using the proper convention below.
<type>(optional scope): <description>
Example: feat(pre-event): add speakers section
| Commit Type | Title | Description | Emoji |
|---|---|---|---|
feat |
Features | A new feature | ✨ |
fix |
Bug Fixes | A bug Fix | 🐛 |
docs |
Documentation | Documentation only changes | 📚 |
style |
Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 |
refactor |
Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 |
perf |
Performance Improvements | A code change that improves performance | 🚀 |
test |
Tests | Adding missing tests or correcting existing tests | 🚨 |
build |
Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 |
ci |
Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ |
chore |
Chores | Other changes that don't modify src or test files | ♻️ |
revert |
Reverts | Reverts a previous commit | 🗑 |
Aliases allow to have additionnal commit types (in a tool like commitizen for example) that can be formatted to follow AngularJS Commit Message Conventions.
For example the commitizen CLI can present the choice initial and the final commit message will be 'feat: Initial commit 🎉'
| Commit Type | Maps to | Title | Description | Emoji |
|---|---|---|---|---|
initial |
feat |
Initial | Initial commit | 🎉 |
dependencies |
fix |
Dependencies | Update dependencies | ⏫ |
peerDependencies |
fix |
Peer dependencies | Update peer dependencies | ⬆️ |
devDependencies |
chore |
Dev dependencies | Update development dependencies | 🔼 |
metadata |
fix |
Metadata | Update metadata (package.json) | 📦 |
Labels per page Ex: feat(pre-event): add date label
*If there is no scope needed, you don't need to write it
Description must fully explain what is being done.
Add BREAKING CHANGE in the description if there is a significant change.
If there are multiple changes, then commit one by one
- After colon, there are a single space Ex:
feat: add something - When using
fixtype, state the issue Ex:fix: file size limiter not working - Use imperative, and present tense: "change" not "changed" or "changes"
- Don't use capitals in front of the sentence
- Don't add full stop (.) at the end of the sentence