|
2 | 2 | ## Feature Branches
|
3 | 3 | Feature branches will take the feature branch name and use that as the pre-release tag.
|
4 | 4 |
|
5 |
| - |
| 5 | + |
6 | 6 |
|
7 | 7 |
|
8 | 8 | ## Pull Request
|
9 | 9 | Because feature branches are most likely pushed to a fork, we are showing the
|
10 | 10 | pull request branch name which is created when you submit a pull request
|
11 | 11 |
|
12 |
| - |
| 12 | + |
13 | 13 |
|
14 | 14 |
|
15 | 15 | ## Hotfix Branches
|
16 | 16 | Hotfix branches are used when you need to do a *patch* release in GitFlow and are always created off `master`
|
17 | 17 |
|
18 |
| - |
| 18 | + |
19 | 19 |
|
20 | 20 |
|
21 | 21 | ## Minor Release Branches
|
22 | 22 | Release branches are used for both major and minor releases for stabilisation before a release. Release branches are taken off `develop` then merged to both `develop` and `master`. Finally `master` is tagged with the released version.
|
23 | 23 |
|
24 |
| - |
| 24 | + |
25 | 25 |
|
26 | 26 |
|
27 | 27 | ## Major Release Branches
|
28 | 28 | Major releases are just like minor releases, the difference is you bump the major in the release branch name.
|
29 | 29 |
|
30 |
| - |
| 30 | + |
31 | 31 |
|
32 | 32 |
|
33 | 33 | ## Support Branches
|
34 | 34 | Support branches are not really covered in GitFlow, but are essential if you need to maintain multiple major versions at the same time. You could use support branches for supporting minor releases as well. If you are just supporting the majors, then name your branch `support/<major>.x` (i.e `support/1.x`), to support minors use `support/<major>.<minor>.x` or `support/<major>.<minor>.0`. (i.e `support/1.3.x` or `support/1.3.0`)
|
35 | 35 |
|
36 | 36 | ### Hotfix
|
37 | 37 | Depending on what you name your support branch, you may or may not need a hotfix branch. Naming it `support/1.x` will automatically bump the patch, if you name it `support/1.3.0` then the version in branch name rule will kick in and the patch *will not* automatically bump, meaning you have to use hotfix branches.
|
38 |
| - |
| 38 | + |
39 | 39 |
|
40 | 40 |
|
41 | 41 | ### Minor Release
|
42 |
| - |
| 42 | + |
43 | 43 |
|
44 | 44 |
|
45 |
| -## Source |
46 |
| - |
47 |
| -See `DocumentationSamples.GitFlowExample`. To update, modify then run test. Update [https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb](https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb) |
| 45 | +## To Update/Contribute |
| 46 | +See [creating/updating examples](creating-updating-examples.md) |
0 commit comments