Commit Message Conventions

[soran-ghaderi]

Commit Conventions

The first line should be max 50-60 chars. Any further details should be in the next lines separated by an empty line.

• ✨ feat: Introduces a new feature.
• 🐛 fix: Patches a bug in the codebase.
• 📖 docs: Changes related to documentation.
• 💎 style: Changes that do not affect the meaning of the code (e.g., formatting).
• 📦 refactor: Code changes that neither fix a bug nor add a feature.
• 🚀 perf: Improvements to performance.
• 🚨 test: Adding or correcting tests.
• 👷 build: Changes affecting the build system or external dependencies.
• 💻 ci: Changes to Continuous Integration configuration.
• 🎫 chore: Miscellaneous changes that don't modify source or test files.
• 🔙 revert: Reverts a previous commit.

Example ✨

feat: new feature implemented

The details of the commit (if any) go here.

[soran-ghaderi]

We welcome contributions! 🙌 If you're interested in improving TorchEBM or adding new features, please check our contributing guidelines.

Our project follows specific commit message conventions to maintain a clear project history and generate meaningful changelogs. 📝

For more, please visit the TorchEBM website. 🌐