This repo adheres to custom angular-emoji commit guideline.
Each commit message consists of a header, a body and a footer. The header includes one or more emojis, a type, a scope and a subject.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory but the body and footer are optionals. The header's scope is optional but the emoji(s), commit type and subject are required. The header must not be longer than 50 characters. Any line of the body or footer must not be longer than 72 characters.
Type must be one of the following with one of the designated emojis:
-
Initial Commit 🎉 Party Popper: Start of the project
-
feat ✨ Sparkles: A new feature
-
fix: Fixes a bug, a typo or a security issue
-
hotfix 🚑 Ambulance: A hotfix
-
refactor [♻️ Black Universal Recycling Symbol] (http://emojipedia.org/black-universal-recycling-symbol/) : A code change that neither fixes a bug nor adds a feature
- move or rename resources 🚚 Delivery Truck
- remove code 🗑️ Wastebasket
- improve error handling 🥅 Goal Net
- work in progress (WIP) 🚧 Construction Sign
-
perf ⚡ High Voltage: A code change that improves performance
-
build 🔨 Hammer: Changes that affect the build system or external dependencies
- add dependency ➕ Plus Sign
- remove dependency ➖ Minus Sign
- upgrade dependency ⬆ Up Arrow
- downgrade dependency ⬇ Down Arrow
- pin dependency version 📌 Pushpin
- change node package files 📦 Package
- deployment 🚀 Rocket
- git ignore changes 🙈 See-No-Evil Monkey
- config files 🔧 Wrench
- database related 🗃 Card File Box
-
docs 📚 Books: Documentation only changes
- licensing 📄 Page Facing Up
- comments 💡 Bulb
- logs 🔊 Speaker High Volume
- i18n 🌐 Globe With Meridians
-
style 🎨 Artist Palette: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-
test 🧪 Test Tube: Adding missing tests or correcting existing tests
- adds a test ✅ Check Mark Button
- make a test pass ✔ Check Mark
-
revert ⏪ Fast Reverse Button: Reverts a previous commit. It should begin with
revert:, followed by the header of the reverted commit. In the body it should say:This reverts commit <hash>., where the hash is the SHA of the commit being reverted
This emojis can be added to the type emoji to notify about certain condition:
- bookmark 🔖 Bookmark
- breaking change 💥 Boom
- deprecation ⚰ Coffin
The scope should be the name of the npm package affected. The following is the list of supported scopes:
- api
- frontend
- packaging: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
- none/empty string: useful for
style,testandrefactorchanges that are done across all packages (e.g.style: add missing semicolons) and for docs changes that are not related to a specific package (e.g.docs: fix typo in LICENSE).
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space
or two newlines. The rest of the commit message is then used for this.