Skip to content

Commit b0b4984

Browse files
committed
[SYCL] Add guidelines for working on release branches
1 parent 73e6b22 commit b0b4984

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

sycl/ReleaseNotes.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
# Release notes for an upcoming release (dates TBD)
2+
3+
## New Features
4+
5+
- Added suport for ... intel/llvm#pr
6+
7+
## Improvements
8+
9+
- Improved handling of ... intel/llvm#pr
10+
11+
## Bug Fixes
12+
13+
- Fixed ... intel/llvm#pr
14+
15+
## Misc
16+
17+
- Did this and that ... intel/llvm#pr
18+
119
# Release notes Jul'24
220

321
Release notes for commit range

sycl/doc/developer/ContributeToDPCPP.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,33 @@ For any DPC++-related commit, the `[SYCL]` tag should be present in the
3737
commit message title. To a reasonable extent, additional tags can be used
3838
to signify the component changed, e.g.: `[UR]`, `[CUDA]`, `[Doc]`.
3939

40+
## Release notes
41+
42+
You are encouraged (but it is not required) to record your change into
43+
[release notes](/sycl/ReleaseNotes.md) under "Release notes for an upcoming
44+
release" section.
45+
46+
A change should be noted there when:
47+
48+
- A public interface (API, command line options, env variables, etc.) is being
49+
changed
50+
- A bug is being fixed
51+
- Any change is being made which has an observable behavior (including
52+
performance)
53+
54+
A change should **not** be noted there when:
55+
56+
- It has no functional and performance impact
57+
- It is about our CI infrastructure, testing infrastructure, or tests
58+
59+
There are no strict guidelines on how to structure release notes, but for
60+
consistency it is better to follow the existing structure without disrupting it
61+
much. The structure we have been using so far is split by change type (i.e. new
62+
features and bug fixes) and then sub-split by component (i.e. compiler,
63+
runtime). Please use past tense when describing your change.
64+
65+
When in doubt, you can always ask reviewers for help/guidance/suggestions.
66+
4067
## Using \<iostream\>
4168

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

0 commit comments

Comments
 (0)