diff options
| author |  Drew DeVault <sir@cmpwn.com> | 2016-09-05 12:11:39 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2016-09-05 12:11:39 -0400 |
| commit | a89105e62d95ccb8871ff27ef9661c698257e792 (patch) | |
| tree | 63c5c7e5afdcec4ed3928c8062b7804e65361a34 /CONTRIBUTING.md | |
| parent | Document release cycle in CONTRIBUTING.md (diff) | |
| download | sway-a89105e62d95ccb8871ff27ef9661c698257e792.tar.gz sway-a89105e62d95ccb8871ff27ef9661c698257e792.tar.zst sway-a89105e62d95ccb8871ff27ef9661c698257e792.zip | |
Minor cleanup on CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c671126..05b259ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -7,24 +7,23 @@ your plans. | |||
| 7 | 7 | ||
| 8 | ## Release Cycle | 8 | ## Release Cycle |
| 9 | 9 | ||
| 10 | There are three stages of a sway release. Say the current stable version is | 10 | The master branch of sway is always working towards becoming the next release. |
| 11 | 0.7. The master branch of sway is working towards becoming the 0.8 release. 0.8 | 11 | That release will go through each of these three stages: |
| 12 | will go through each of these three stages: | ||
| 13 | 12 | ||
| 14 | **In development**: during this time 0.8 lives in the master branch and is | 13 | **In development**: during this time the release lives in the master branch and |
| 15 | considered unstable. All pull requests merged during this time will land in sway | 14 | is considered unstable. All pull requests merged during this time will land in |
| 16 | 0.8. | 15 | this version. Only developers are encouraged to run this version. |
| 17 | 16 | ||
| 18 | **Release candidate**: at some point (usually when development is fairly quiet), | 17 | **Release candidate**: at some point (usually when development is fairly quiet), |
| 19 | @SirCmpwn will announce an upcoming release candidate (often 2 weeks in | 18 | SirCmpwn will announce an upcoming release candidate (often 2 weeks in |
| 20 | advance). When the two weeks are up, a branch is cut (i.e. 0.8-rc1) and from | 19 | advance). When the two weeks are up, a branch is cut (i.e. 0.8-rc1) and from |
| 21 | that point only bugfix pull requests land in this branch. Each morning, if | 20 | that point only bugfix pull requests land in this branch. Each morning, if |
| 22 | bugfixes landed in 0.8 during the previous day, a new RC is cut. During the RC | 21 | bugfixes landed during the previous day, a new RC is cut. During the RC phase, |
| 23 | phase, more adventurous users are encouraged to upgrade and start looking for | 22 | more adventurous users are encouraged to upgrade and start looking for and |
| 24 | and reporting bugs (especially in new features). | 23 | reporting bugs (especially in new features). |
| 25 | 24 | ||
| 26 | **Stable release**: when no substantial changes are merged into an RC for 1 | 25 | **Stable release**: when no substantial changes are merged into an RC for one |
| 27 | week, it's released as a new stable version of Sway. At this point, all users | 26 | week, it's released as a new stable version of sway. At this point, all users |
| 28 | are encouraged to upgrade. | 27 | are encouraged to upgrade. |
| 29 | 28 | ||
| 30 | ## Pull Requests | 29 | ## Pull Requests |