Skip to main content

📝 Commit Guidelines

We follow Conventional Commits to maintain a structured and meaningful commit history.

✅ Commit Message Format

Each commit message should follow this format:

<type>(<optional scope>): <short message>

🔹 Common Commit Types

TypeDescription
featIntroduces a new feature
fixFixes a bug
docsDocumentation updates
choreMaintenance tasks (e.g., build scripts, dependencies)
testAdding or modifying tests
refactorCode restructuring without changing functionality
styleFormatting changes, missing semi-colons, etc. (no logic changes)
perfPerformance improvements
ciChanges to CI/CD workflows

📌 Example Commit Messages

git commit -m "feat(auth): add login functionality"
git commit -m "fix(cart): resolve issue with item removal"
git commit -m "docs(readme): update installation instructions"
git commit -m "chore(deps): update eslint dependencies"

💡 Best Practices

  • Use imperative moodfix issue instead of fixed issue
  • Keep messages concise but descriptive
  • Use scopes when relevant(auth), (cart), (docs), etc.
  • Separate concerns into different commits

By following Conventional Commits, we maintain a clear and meaningful commit history that improves collaboration and project tracking. 🚀