Contributing to Meeseeks

Commit Guidelines

We embrace the use of emojis to bring life and clarity to our commit messages, keeping the process engaging and organized. For an efficient emoji guide, visit Gitmoji.

Key Principles:

• Imperative Tone: Frame your commit messages as direct commands. For instance, prefer "Add feature" over "Added feature".
• Emoji Use: Simplify and categorize your commits with these emojis:
  • 📦 NEW: Introducing new features.
  • 👌 IMPROVE: Enhancing existing functionality.
  • 🐛 FIX: Correcting bugs.
  • 📖 DOC: Updating or adding documentation.
  • 🚀 RELEASE: Releasing new versions.
  • 🤖 TEST: Committing test files.
  • ‼️ BREAKING: Making changes that break backward compatibility.

Employ tools like VSCode to facilitate precise commits with appropriately tagged messages.

Release Guidelines

We adhere to Semantic Versioning (SemVer) to manage our version numbers meaningfully and systematically. This strategy helps in tracking compatibility and incrementing versions correctly.

Key Points:

• Major Versions (X.y.z) - Introduce breaking changes.
• Minor Versions (x.Y.z) - Add backward-compatible functionality.
• Patch Versions (x.y.Z) - Implement backward-compatible bug fixes.

For a detailed understanding of our versioning practice, visit Semantic Versioning.