You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
β¨ General Rules:
All commits and branch names must be written in lowercase. π‘
Follow the format below for branches and commits.
πΏ Types of Branches
Type
Description
feat
π New features
fix
π Bug fixes
remove
ποΈ Removing 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
βοΈ Small changes
chore
π§Ή Other changes
π Example Branch Names
feat/user-registration π
fix/product-price-validation π
docs/readme-update π
style/button-styling π¨
π Types of Commits
Type
Description
feat
π A new feature
fix
π A bug fix
docs
π Documentation changes
style
π¨ Changes that do not affect code meaning (e.g., formatting)
refactor
π Code changes that neither fix a bug nor add a feature
perf
β‘ Changes that improve performance
test
β Adding or correcting tests
build
ποΈ Changes affecting the build system or dependencies
ci
π€ Changes to CI configuration files and scripts
chore
π§Ή Maintenance or other changes that donβt fit elsewhere
π¬ Commit Message Format
A good commit message is:
Clear and descriptive: Explains the "what" and "why" of the change.
Concise: Less than 72 characters for the subject line.
π Example Commit Messages
feat: add user registration support π
fix: fix price validation error π
docs: update installation section π
Thanks for following the guidelines and helping us maintain a great project! πβ¨
The text was updated successfully, but these errors were encountered:
Commit Guidelines | BABYBEAST
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
β¨ General Rules:
πΏ Types of Branches
feat
fix
remove
docs
style
refactor
perf
test
build
ci
change
chore
π Example Branch Names
feat/user-registration
πfix/product-price-validation
πdocs/readme-update
πstyle/button-styling
π¨π Types of Commits
feat
fix
docs
style
refactor
perf
test
build
ci
chore
π¬ Commit Message Format
A good commit message is:
π Example Commit Messages
feat: add user registration support
πfix: fix price validation error
πdocs: update installation section
πThanks for following the guidelines and helping us maintain a great project! πβ¨
The text was updated successfully, but these errors were encountered: