Contributing Guidelines

Thank you for your interest in contributing! To keep the commit history clean and readable, I follow a specific convention.

Commit Messages

I use a combination of emojis and prefixes. However, using these emojis/prefixes is OPTIONAL for contributors.

How to Write a Commit Message

• If you're unsure: Simply write a clear description in plain text. I will format it (add emojis/prefixes) when merging your Pull Request.
• If you'd like to follow the style: Use the format [Emoji][Prefix]: [Message].

Commit Style Reference

• ✨ feat: - New features
• 🐞 fix: - Bug fixes
• ✏️ typo: - Typo
• 📝 docs: - Documentation changes
• 🔨 refactor: - Code changes that neither fix a bug nor add a feature
• 🎨 style: - Changes that do not affect the meaning of the code (white-space, formatting, etc.)
• ✅ test: - Adding or correcting tests
• ⏪ revert: - Reverting a previous commit
• 🔀 merge - Merging branches
• 🔧 chore: - Updating build tasks, package manager configs, etc.
• 🎉 release: - Release commits / Version tags
• 💔 broke: - Breaking changes