mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-12-25 18:59:33 +03:00
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 <behlendorf1@llnl.gov> Signed-off-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl> Closes #10976
This commit is contained in:
parent
af20b97078
commit
595b7e99d3
15
.github/CONTRIBUTING.md
vendored
15
.github/CONTRIBUTING.md
vendored
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user