Skip to content

Contributing: Branch Naming Syntax

Jonathan Niles edited this page May 6, 2016 · 4 revisions

This is a guide to help new contributors have clear and consistent branch names when contributing to the project. Contributors are not forced to abide by these suggestions, but these guidelines will help ensure easy reviews and deployment of their branches.

Basic Guidelines

  1. Use dashes (-) in branch names, avoid slashes (/).
    1. Branches with dashes can be easily deployed as Heroku review applications.
  2. Begin the branch name with an action, similar to commit message types. For example:
    1. chore-*
    2. refactor-*
    3. test-*
    4. feature-*
  3. Make branch names as long as needed. There is no reason to omit information just to have a shorter branch name.