comparison WORKFLOW.md @ 1166:6970bffad843 worklowdocs

Add some exmples of branch names
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 07 Dec 2022 21:45:26 +0100
parents 32b4d324fd98
children 48cbcbc7a40b
comparison
equal deleted inserted replaced
1165:32b4d324fd98 1166:6970bffad843
5 Branches are named using slash separated keywords. The first keyword describes the type of change being pursued in the branch. Important type keywords are 5 Branches are named using slash separated keywords. The first keyword describes the type of change being pursued in the branch. Important type keywords are
6 * feature 6 * feature
7 * bugfix 7 * bugfix
8 * refactor 8 * refactor
9 Further keywords may describe where, e.g. what sub package, the change happens. The last keyword should describe the change. 9 Further keywords may describe where, e.g. what sub package, the change happens. The last keyword should describe the change.
10
11 Some examples:
12 * refactor/grids: Branch to refactor the grids module
13 * bugfix/lazy_tensors/lazyfunctionarray: Branch to fix a bug in LazyFunctionArray
10 14
11 ## Merging a branch into `default` 15 ## Merging a branch into `default`
12 The changes in a branch has been reviewed and deemed ready to merge the branch is closed and then merged. 16 The changes in a branch has been reviewed and deemed ready to merge the branch is closed and then merged.
13 17
14 Before merging a development branch, `default` should be merge into the development branch to make sure the whole state of the code is reviewed and tested before it ends up on `default`. 18 Before merging a development branch, `default` should be merge into the development branch to make sure the whole state of the code is reviewed and tested before it ends up on `default`.