Skip to content

Git workflow

Karol Lasończyk edited this page Feb 5, 2018 · 3 revisions

Git workflow

Git workflow in the nrfx project is simple. New feature branches should be branched from the master branch and merge back to the master branch using pull requests. History is linear.

Please name branches starting from proper prefix to point which change will be intoduced:

  • feature/* - For new features or changes in existing code.
  • bugfix/* - For bugfixes in existing code.

Working on branches

There are few important rules to be fulfilled before merging back branch to the master branch.

  • Be sure that CLA (Contributor License Agreement) was accepted.
  • Make commits clear and consistent. Please make sure that commit is well described and contains one logical change (see Commit message rules for more). In case of having more commits connected to one logical change please squash them.
  • Rebase branch at the top of the master branch to be mergable. Upmerges are prohibited.
  • Introduce review changes in existing commits if possible. That changes have to be done using rebase interactive git function.