-
Notifications
You must be signed in to change notification settings - Fork 142
Git workflow
Bartosz Gentkowski edited this page Feb 6, 2018
·
3 revisions
The nrfx project follows a simple git workflow. New feature branches are branched from the master branch and merged back to the master branch using pull requests. History is linear.
Name the branches starting from a proper prefix to indicate what kind of change is introduced:
- feature/* - For new features or changes in the existing code.
- bugfix/* - For bug fixes in the existing code.
Before merging a branch back to the master branch, a few requirements must be met.
- Make sure that CLA (Contributor License Agreement) has been accepted.
- Make commits clear and consistent. Make sure that each commit is well-described and contains one logical change (see Commit message rules for more). If there are more commits related to one logical change, squash them.
- Rebase the branch at the top of the master branch to be mergeable. Upmerges are prohibited.
- Avoid new commits for changes originating from reviews. If possible, use the interactive rebase function to introduce these changes into the existing commits.