Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐣 GIT GUIDELINE 🐣 #33

Closed
juandiegocv27 opened this issue Jan 15, 2025 · 0 comments
Closed

🐣 GIT GUIDELINE 🐣 #33

juandiegocv27 opened this issue Jan 15, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@juandiegocv27
Copy link
Contributor

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:

  • 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! πŸš€βœ¨

@juandiegocv27 juandiegocv27 pinned this issue Jan 15, 2025
@RolandoDrRobot RolandoDrRobot changed the title 🐣GIT GUIDELINE 🐣 Git guideline Jan 15, 2025
@RolandoDrRobot RolandoDrRobot added the documentation Improvements or additions to documentation label Jan 15, 2025
@RolandoDrRobot RolandoDrRobot unpinned this issue Jan 15, 2025
@juandiegocv27 juandiegocv27 pinned this issue Jan 15, 2025
@juandiegocv27 juandiegocv27 removed their assignment Jan 15, 2025
@juandiegocv27 juandiegocv27 changed the title Git guideline 🐣GIT GUIDELINE 🐣 Jan 15, 2025
@juandiegocv27 juandiegocv27 changed the title 🐣GIT GUIDELINE 🐣 🐣 GIT GUIDELINE 🐣 Jan 15, 2025
@ByteBuildersLabs ByteBuildersLabs locked as spam and limited conversation to collaborators Jan 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants