Skip to content

Commit

Permalink
Document branching structure
Browse files Browse the repository at this point in the history
This change documents the currently used branching structure.
It has been cut down to not include any controversial changes.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
Closes #10976
  • Loading branch information
Kjeld Schouten-Lebbing authored and behlendorf committed Oct 1, 2020
1 parent 1579483 commit e5a4f9c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e5a4f9c

Please sign in to comment.