Intro
This document will go over GitHub branching best practices
Basic Flow
The two primary branches on the tech dashboard are dev and master. Neither branch will be directly committed to. Only PRs will be used to alter dev and master. To make a new feature, a branch will be created based off of dev and then a PR will be made into dev once it is completed. Later dev and master will be synced via a PR
Naming Conventions
Feature branches should be named “feature/<a_descriptive_name>”
Hotfix branches should be named “hotfix/<a_descriptive_name>”
Linking Issues
Each PR should contain a single issue and link that issue
PR Descriptions
The description should contain a bulleted list of changes to make the PR review faster and easier
Deleting Branches After Merge
TBD
Helpful Links
Add Comment