Commit Guidelines | TRUSTLESS WORK
This guideline aims to establish a clear set of conventions for commit messages in this project. Following these conventions helps maintain a clear and consistent commit history.
Commit and Branches Structure
The message should follow the format:
NOTE: ALL THE COMMITS AND BRANCHES SHOULD BE IN LOWERCASE
Types of Branches
- feat: New features
- fix: Bug fixes
- remove: Files
- docs: Documentation updates
- style: Style changes
- refactor: Refactoring code
- perf: Performance improvements
- test: Test-related changes
- build: Build system changes
- ci: CI changes
- change: Littles changes
- chore: Other changes
Example Branch Names
feat/user-registration
fix/product-price-validation
docs/readme-update
style/button-styling
Types of Commits
feat: A new feature
fix: A bug fix
docs: Documentation changes
style: Changes that do not affect the meaning of the code (formatting, etc.)
refactor: Code changes that neither fix a bug nor add a feature
perf: Changes that improve performance
test: Adding missing tests or correcting existing tests
build: Changes that affect the build system or external dependencies
ci: Changes to CI configuration files and scripts
chore: Maintenance changes that do not fall into any of the other categories
Message
The message should be clear and descriptive, including the "what" and "why" of the change. It should be concise (less than 72 characters).
Example Commit Messages
feat: add user registration support
fix: fix price validation error
docs: update installation section
Thanks for follow the guidelines
Commit Guidelines | TRUSTLESS WORK
This guideline aims to establish a clear set of conventions for commit messages in this project. Following these conventions helps maintain a clear and consistent commit history.
Commit and Branches Structure
The message should follow the format:
NOTE: ALL THE COMMITS AND BRANCHES SHOULD BE IN LOWERCASE
Types of Branches
Example Branch Names
feat/user-registrationfix/product-price-validationdocs/readme-updatestyle/button-stylingTypes of Commits
feat: A new featurefix: A bug fixdocs: Documentation changesstyle: Changes that do not affect the meaning of the code (formatting, etc.)refactor: Code changes that neither fix a bug nor add a featureperf: Changes that improve performancetest: Adding missing tests or correcting existing testsbuild: Changes that affect the build system or external dependenciesci: Changes to CI configuration files and scriptschore: Maintenance changes that do not fall into any of the other categoriesMessage
The message should be clear and descriptive, including the "what" and "why" of the change. It should be concise (less than 72 characters).
Example Commit Messages
feat: add user registration supportfix: fix price validation errordocs: update installation sectionThanks for follow the guidelines