Skip to content

Commit 4884102

Browse files
committed
[Markdown] Contributing: Add section about release branch PRs
In an effort to centralize the release branch PR form in particular and nomination process in general, dedicate a section to this for repositories and forums announcements to refer to instead of each publishing their own — sometimes slightly different, without good reason — versions.
1 parent f2fe939 commit 4884102

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

contributing/_contributing-code.md

+31
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,37 @@ For C or C++ source or header files, the code header should look this:
111111

112112
The divider lines should be exactly 80 characters wide to aid in adherence to the code style guidelines. The bottom section contains an optional description intended for generated documentation (these lines begin with `///` rather than `//`). If there is no description, this area can be skipped.
113113

114+
### Release Branch Pull Requests
115+
116+
*All changes* to a release branch (`release/x.y`) must be proposed through pull
117+
requests.
118+
A pull request targeting a release branch cannot be merged without an approval
119+
by the corresponding release manager.
120+
In order for a change to be considered for inclusion in a release branch, the
121+
pull request must have:
122+
123+
* A title that starts with a `[x.y]` tag matching the release version of the
124+
target branch
125+
126+
* The following form filled out in its description:
127+
128+
```
129+
- **Explanation**: A description of the change. This can be brief, but it
130+
should be clear.
131+
- **Scope**: An assessment of the impact and importance of the change. For
132+
example, is the change a source-breaking language change?
133+
- **Issues**: References to issues the change resolves, if any.
134+
- **Original PRs**: Links to the mainline branch pull requests, the changes
135+
from which make up this pull request, if any.
136+
- **Risk**: The (specific) risk to the release for taking this change.
137+
- **Testing**: The specific testing that has been done or needs to be done to
138+
further validate any impact of this change.
139+
- **Reviewers**: The code owners that approved the mainline branch pull
140+
requests. If any part of the mainline branch changes was not approved by a
141+
respective code owner, provide a reason. Technical review can be delegated
142+
by a code owner or otherwise requested as deemed appropriate or useful.
143+
```
144+
114145
### Code Review
115146

116147
The Swift project relies heavily on code review to improve software quality:

0 commit comments

Comments
 (0)