🐺 GIT GUIDELINE 🐺

[jimenezz22]

Commit Guidelines

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! 🚀✨