Branching Strategies
- Mikah Pinegar
- Chris Reberg-Horton
Intro
This document will go over GitHub branching best practices.
Basic Flow
The two primary branches on any repo we maintain should be development and main. Neither branch will be directly committed to and will be a protected branch. 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. PRs into dev will require at least one reviewer and PRs into master will require at least 2 reviewers.
Naming Conventions
Feature branches should be named “feature/<GitHub issue number>-<a-descriptive-name>”.
Hotfix branches should be named “hotfix/<GitHub issue number>-<a-descriptive-name>”.
Pull Request Best Practices
All pull requests should be reviewed by another member of the team who has a basic understanding of the project.
Each PR into dev should contain a single GitHub issue and link that issue. Each PR into master should link all issues that are contained within the PR.
The description should contain a bulleted list of changes to make the PR review faster and easier.
Once a feature or hotfix branch has been merged it should be deleted.
A good review includes checking documentation. Check comments in the code and updates to readme.md and confluence.
Helpful Links