diff options
| author | Kjeld Schouten-Lebbing <[email protected]> | 2020-09-28 22:23:49 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-09-28 13:23:49 -0700 |
| commit | 595b7e99d38f42e433bc0736d51d8f3be394e20f (patch) | |
| tree | 9c023320e620feeffb1da547c75e7f6095c0a2ce /.github | |
| parent | af20b97078af7bf4ba7552dff04cc40b643ab72c (diff) | |
Document branching structure
This change documents the currently used branching structure.
It has been cut down to not include any controversial changes.
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Kjeld Schouten-Lebbing <[email protected]>
Closes #10976
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4e2c8901d..f28a747e8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -175,6 +175,21 @@ to verify ZFS is behaving as intended. ## Style Guides +### Repository Structure + +OpenZFS uses a standardised branching structure. +- The "development and main branch", is the branch all development should be based on. +- "Release branches" contain the latest released code for said version. +- "Staging branches" contain selected commits prior to being released. + +**Branch Names:** +- Development and Main branch: `master` +- Release branches: `zfs-$VERSION-release` +- Staging branches: `zfs-$VERSION-staging` + +`$VERSION` should be replaced with the `major.minor` version number. +_(This is the version number without the `.patch` version at the end)_ + ### Coding Conventions We currently use [C Style and Coding Standards for SunOS](http://www.cis.upenn.edu/%7Elee/06cse480/data/cstyle.ms.pdf) as our |