From e5a4f9cfc44e79aff2fdbeb7ccf8d9bc7f5b1a08 Mon Sep 17 00:00:00 2001 From: Kjeld Schouten-Lebbing Date: Mon, 28 Sep 2020 22:23:49 +0200 Subject: [PATCH] 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 Signed-off-by: Kjeld Schouten-Lebbing Closes #10976 --- .github/CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5b3e7fa2a..9bc2e7ef0 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