Commit Conventions

Commit types

• feat: Adds a new feature (corresponds to a minor version bump).
• fix: Bug fix (patch version bump).
• refactor: Code change that does not add a feature or fix a bug (performance, readability, etc.).
• docs: Documentation-only changes.
• style: Changes to formatting, whitespace, or punctuation that do not affect functionality.
• test: Adding or correcting tests.
• chore: Changes related to tools, build, or maintenance that do not affect production code.
• perf: Performance improvements.
• build: Changes to the build system or external dependencies.
• merge: Merge a branch.
• CI: Changes to continuous integration configuration.

Key rules

1. Prefix: All commits start with the type in lowercase, followed by a colon and a space (e.g., fix: ).
2. Subject: A short, imperative description of the change (e.g., feat: add user profile), it should not exceed 50 characters with the prefix included.
3. Subject: Use the imperative mood to describe the change.
4. Body: A more detailed explanation can be added after the subject, separated by a blank line (each body line should not exceed 72 characters).
5. Body: should explain what are the changes and why, not how.
6. Breaking Changes: Explicitly mention in the commit body with the keyword BREAKING CHANGE: followed by the description.