@atjson/conventional-commits v0.8.4
✌️ conventional-commits
Conventional Commits is a community standard designed to generate software changes automatically.
We use emoji for our conventional commits to reduce technical jargon in our software.
Commits look like ✌️ My awesome change (#12). There’s emoji at the beginning, the description of the changes made in the middle and the number referencing the GitHub pull request at the end.
❤️ Supported emoji
| Emoji | Changelog Heading | Severity | Included in Changelog? |
|---|---|---|---|
| 🏗 | 🏗 Build Changes | patch | 🚫 |
| 📦 | 📦 npm changes | patch | 🚫 |
| 🚨 | 🚨 Breaking Changes | breaking | ✅ |
| 👷♀️ | 👷♀️ TravisCI | patch | 🚫 |
| 👷♂️ | 👷♂️ TravisCI | patch | 🚫 |
| 🗻 | 🗻 CodeClimate | patch | 🚫 |
| 👩⚖️ | ⚖️ Licensing Changes | major | ✅ |
| 👨⚖️ | ⚖️ Licensing Changes | major | ✅ |
| ⚖️ | ⚖️ Licensing Changes | major | ✅ |
| 📓 | 📚 Documentation | patch | 🚫 |
| 📚 | 📚 Documentation | patch | 🚫 |
| ✨ | ✨ New Features | minor | ✅ |
| 🎉 | ✨ New Features | minor | ✅ |
| 🎊 | ✨ New Features | minor | ✅ |
| 🐛 | 🐛 Fixes | patch | ✅ |
| 🐝 | 🐛 Fixes | patch | ✅ |
| 🔒 | 🔒 Security Updates | patch | ✅ |
| 🚀 | 🚀 Performance | patch | 🚫 |
| 🛀 | 🛀 Code Cleanup | patch | 🚫 |
| ⏪ | ⏪ Undo Changes | revert | 🚫 |
| 💅 | 💄 Style | patch | 🚫 |
| 💄 | 💄 Style | patch | 🚫 |
| 🎨 | 💄 Style | patch | 🚫 |
| 🚦 | 🚦 Tests | patch | 🚫 |
| 🚥 | 🚦 Tests | patch | 🚫 |
PS: Use any skin tone you want– we'll detect it regardless of the skin tone and put it under the correct heading 😘
🙋♀️ Do you have an emoji that you'd like to add?
Add your emoji to this spreadsheet with the heading that it should live under, the severity of the change, and a 🚫 or ✅ indicating whether it should be included in the changelog.
The severity can be one of the following:
patchindicates fixes and other changesminorindicates new features (and possibly fixes as well)major/breakingindicates that the software now works differently and will need to be updated accordingly
👉 Examples
Let’s use the commit examples used above:
- 📦 Release 0.2.8
- 🐛 Fix nested bold and italic markdown output (#32)
- 🎉 Add horizontal rule and vertical adjustments for Google Docs paste (#52)
- ✨👑✨ Make Annotations classes instead of JS objects (#54)\
\
🚨 Schemas are now defined as a list of annotation classes, cf.
[Bold, Italic]
And show what will be our changelog!
🐛 Fixes
- 🐛 Fix nested bold and italic markdown output (#32)
✨ New Features
- ✨👑✨ Make Annotations classes instead of JS objects (#54)
- 🎉 Add horizontal rule and vertical adjustments for Google Docs paste (#52)
🚨 Breaking Changes
- Schemas are now defined as a list of annotation classes, cf.
[Bold, Italic]
7 years ago