We are using git as version control and GitHub as repository hosting
- Create a branch following the branching conventions
- Make changes to the code, test locally, commit and push to remote
- Create a pull request and request review.
- Address review comments
- Re-request review
- master
- dev
- hotfix
- A dev branch is created from master
- Feature branches are created from dev
- When a feature is complete it is merged into the dev branch
- If an issue in master is detected a hotfix branch is created from master
- Once the hotfix is complete it is merged to both dev and master
| prefix | usage |
|---|---|
| feature/ | Feature branches are used for specific feature work or improvements. They generally branch from, and merge back into, the development branch, by means of pull requests. |
| bugfix/ | Bugfix branches are typically used to fix release branches. |
| hotfix/ | Hotfix branches are used to quickly fix the production branch without interrupting changes in the development branch. |
Eg: feature/my-feature-branch
- Add the suitable branch prefix (Eg:
feature/) - Add a short description using lower case letters and dash as the separator. Avoid long descriptive names. (Eg:
my-feature-branch)