Skip to content

Branch Naming Conventions 🌿

Be Descriptive

  • Choose branch names that clearly convey their purpose.
  • Avoid generic names like "feature" or "fix."
  • Use hyphens or underscores to separate words (e.g., add-user-authentication).

Include Context

  • Prefix branches with relevant information:
    • feature/: For new features.
    • bugfix/: For fixing bugs.
    • hotfix/: For critical fixes.
    • chore/: For maintenance tasks.
    • release/: For preparing releases.

Use Lowercase Letters

  • Keep branch names in lowercase for consistency.
  • Avoid uppercase letters or spaces.

Reference Linear Tickets

  • Include the Linear ticket ID in the branch name to link branches with specific tasks.
  • Format: [context]/[ticket-ID]-[short-description] (e.g., feature/PROJ-123-add-user-auth).

Short and Sweet

  • Aim for concise branch names.
  • Avoid overly long or cryptic names.

Released under the MIT License.