|
| 1 | +# Working on a release branch |
| 2 | + |
| 3 | +A "release branch" is defined as a branch whose name starts with `sycl-rel-` |
| 4 | +prefix. |
| 5 | + |
| 6 | +Those branches are intended to indicate stable snapshots of our product so that |
| 7 | +our users don't need to guess which nightly build is good enough for their |
| 8 | +needs. |
| 9 | + |
| 10 | +Therefore, those branches have higher quality requirements and as such have |
| 11 | +different contribution rules intended to preserve their stability. |
| 12 | + |
| 13 | +If you are not familiar with the [general contribution guidelines][contributing] |
| 14 | +or the [DPC++ specific contribution guidelines][contributing-to-dpcpp], please |
| 15 | +familiarize yourself with those documents first because they also apply to |
| 16 | +release branches. |
| 17 | + |
| 18 | +## Extra rules for release branches |
| 19 | + |
| 20 | +### Only cherry-picks are allowed |
| 21 | + |
| 22 | +It is assumed that everything you do on a release branch should also be |
| 23 | +repeated on the default `sycl` branch to ensure that it is automatically |
| 24 | +included into future releases. |
| 25 | + |
| 26 | +Therefore, when submitting a PR to a release branch, its description should |
| 27 | +contain a link to the corresponding PR in the default `sycl` branch. |
| 28 | + |
| 29 | +Note that it is not acceptable to first merge something into a |
| 30 | +release branch and then apply it to the default `sycl` branch. The flow goes in |
| 31 | +the opposite direction where you first land a patch to the default `sycl` branch |
| 32 | +and then backport it to a release branch. |
| 33 | + |
| 34 | +### No new features are allowed |
| 35 | + |
| 36 | +Features are generally more complicated than bug fixes and may require further |
| 37 | +bug fixes as well. Considering that release branches are intended to be stable, |
| 38 | +no new features are allowed to be added there. |
| 39 | + |
| 40 | +[contributing]: https://github.com/intel/llvm/blob/sycl/CONTRIBUTING.md |
| 41 | +[contributing-to-dpcpp]: ./ContributeToDPCPP.md |
0 commit comments