We follow the Conventional Commits specification for commit messages in this repository. This ensures a consistent and readable commit history, making it easier to understand changes and automate versioning.
Each commit message must follow this format:
<type>[optional scope]: <description>
[optional body]
[optional footer]
- Type: Describes the kind of change being made. Common types include:
feat: A new featurefix: A bug fixdocs: Documentation changesstyle: Code style changes (e.g., formatting)refactor: Code refactoringtest: Adding or updating testschore: Maintenance or tooling changes
- Scope (optional): Specifies the part of the codebase affected by the change (e.g.,
api,ui,config). - Description: A concise summary of the change.
- Body (optional): A detailed explanation of the change, if necessary.
- Footer (optional): Used for referencing issues (e.g.,
Closes #123) or breaking changes.
feat(api): add user authentication endpointfix(ui): resolve button alignment issuedocs: update installation guidechore: update dependencies
- Improved readability: Commit messages are easier to understand.
- Automated versioning: Tools like semantic-release can automatically determine version bumps based on commit types.
- Better changelogs: Commit history can be used to generate detailed and structured changelogs.
Please ensure all commits adhere to this convention. Thank you for your cooperation!