Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

📌 COMMIT STRATEGY

🔧 Setup

make setup-commit-hook

✅ Commit Message Format

[<service>] (<type/feature-name>): <Capitalized short description>

💡 Allowed Types

  • feat – New feature or functionality
  • fix – Bug fix or issue correction
  • patch – Minor updates or hotfixes
  • docs – Documentation changes
  • style – Code style changes (formatting, linting)
  • refactor – Code restructuring without behavior change
  • test – Adding or updating tests
  • chore – Build tasks, CI configs, or other maintenance

🧪 Example Commits

[inventory] (feat/add-product): Add product listing endpoint
[auth] (fix/token-expiry): Correct token expiry issue
[payment] (patch/update-paypal): Update PayPal integration
[docs] (docs/readme): Update CLI tool usage instructions

✅ Notes for contributors:

  • Service: Use the relevant service or package name in square brackets.
  • Type/feature-name: Specify the type and concise feature name in parentheses.
  • Description: Must start with an uppercase letter and clearly state the change.