Commit Message Guidelines

Commit Message Guidelines

General Messages

• 📄 Generic message 📄
• ❓ Ask a question ❓ [HELP]:
• 🔰 Tested it out! 🔰 [TEST]:
• 🚧 Work in progress 🚧 [NEED]:
• 🔨 Linting [parser]:

Improvements

• 📐 Improve the format/structure of the code/files 📐 [IMPROVE]:
• ⚡ Improve performance ⚡ [IMPROVE]:
• 🚀 Improve something (anything) 🚀 [IMPROVE]:
• 🆕 Critical changes 🆕 [IMPROVE]:

Documentation

• 📝 Write docs 📝 [PROD]:

Features

• 💡 New idea 💡
• 🎉 New feature 🎉 [FEATURE]:
• ➖ Remove a feature ➖ [FEATURE]:

Code and Files

• 🔖 Add new code/file(s) 🔖 [FILE]:
• 🔥 Remove code/file(s) 🔥 [FILE]:
• ✏️ Rename/move a file(s)/folder(s) ✏️ [FILE]:

Production

• 📢 Add logging 📢 [PROD]:
• 🔇 Reduce logging 🔇 [PROD]:
• 🌍 Deploy 🌍 [PROD]:

Dependencies

• 📦 Add/update a new dependency 📦 [PACKAGE]:
• 👐 Remove a dependency 👐 [PACKAGE]:
• ⤴️ Upgrade dependency ⤴️ [PACKAGE]:
• ⤵️ Downgrade dependency ⤵️ [PACKAGE]:

Testing

• ✅ Add tests (TDD) ✅ [TEST]:

Security

• 🔐 When dealing with security 🔐

Warnings

• ⚠️ Warning (Draw attention to sth) ⚠️ [WARNING]:

Storybook

• 📚 Storybook 📖 [STORY]:

Automation

• 🤖 Dependabot update yarn.lock and package.json files, with yarn dependabot (git pull; yarn) 🤖 [DEPENDABOT]:

Release Management

• 🔜 When something is to be released/deployed 🔜
• 🔚 When something is to be disabled, not be available/end support of it 🔚