Skip to content

Instantly share code, notes, and snippets.

@sagarpanchal
Last active August 31, 2022 07:04
Show Gist options
  • Save sagarpanchal/addbf38e137dbfbc3e51461d18d87521 to your computer and use it in GitHub Desktop.
Save sagarpanchal/addbf38e137dbfbc3e51461d18d87521 to your computer and use it in GitHub Desktop.

Branch Types

  • 🚑 hotfix/ - for urgent bug fixes that merge directly into production
  • 🐛 bugfix/ - for bug fixes that merges to staging and then production
  • feature/- to implement new feature
  • 🛠️ changes/ - to improve existing feature/code/algorithm
  • 📃 document/ - add/update documentation
  • 📦 deps/ - add/update dependencies

Branch Names

  • <author>/<branch_type>/<project_name>/<branch_name>
    • author is optional
    • Examples:
      • feature/finestar/bulk-email
      • enhance/finestar/bulk-email
      • bugfix/finestar/bulk-email
      • hotfix/finestar/bulk-email
    • Examples with author:
      • sagar/feature/finestar/bulk-email
      • sagar.panchal/feature/finestar/bulk-email

Commit Messages

  • Commit messages must be short but descriptive
    • Examples:
      • Branch: feature/finestar/bulk-email
        • Commit: add form
        • Commit: add filters
      • Branch: enhance/finestar/bulk-email
        • Commit: allow user to edit email
        • Commit: show selected recipients
        • Commit: add email groups filter
      • Branch: bugfix/finestar/bulk-email
        • Commit: fix file upload
      • Branch: hotfix/finestar/bulk-email
        • Commit: hide sms checkbox
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment