We use a simplified form of Atom's commit convention.
- Use the present tense ("Adds feature" not "Added feature")
- Limit the first line to 72 characters or less
- Add one feature per commit. If you have multiple features, have multiple commits.
<emoji> Short Description of Commit
<BLANKLINE>
More detailed description of commit
<BLANKLINE>
Resolves: <Jira # or Issue #>
Our categories include:
- 🌱
:seedling:when creating a new feature - 🐛
:bug:when fixing a bug - ✅
:white_check_mark:when adding tests - 🎨
:art:when improving the format/structure of the code - 📝
:memo:when writing docs - 🔥
:fire:when removing code or files - 📦
:package:when pushing a new release - ⬆️
:arrow_up:when upgrading dependencies, or generating files - ⬇️
:arrow_down:when downgrading dependencies
If you do not see an exact emoji match, use the best matching emoji.
:memo: Updates CONTRIBUTING.md
Updates Contributing.md with new emoji categories
Updates Contributing.md with new template
Resolves: Issue #X