Git Conventions

Following the below recommendations will keep our repo clean and consistent:

• Create a separate branch for your changes.
  • Use the following naming convention for your branch name:
    • lowercase, snake case description of your change
    • followed by the number of the issue your change addresses
  • e.g., if you created an intent for issue #90, your branch name might look like: added_commuter_rail_intent_90
• Make sure you've squashed all commits on your branch.
  • An easy way to do this is with an interactive rebase:
    • See "Squashing Commits"

Unfamiliar with Git or need a refresh?

Checkout this visual and practical tutorial https://learngitbranching.js.org/ and this Git Cheat Sheet

Back   |   Next