Skip to content

Commit 08f057b

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 08f057b

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

contributing/_contributing-code.md

+49
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,55 @@ 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 nominated through pull
117+
requests and approved by the corresponding release manager.
118+
Nomination of changes for inclusion in a release branch requires that the pull
119+
request has:
120+
121+
* A title that starts with a `[x.y]` tag matching the release version of the
122+
target branch
123+
124+
* The following form filled out in its description:
125+
126+
```
127+
* **Explanation**
128+
129+
A description of the change. This can be brief, but it should be clear.
130+
131+
* **Scope**
132+
133+
An assessment of the impact and importance of the change.
134+
For example, is the change a source-breaking language change?
135+
136+
* **Issues**
137+
138+
References to issues the change resolves, if any.
139+
140+
* **Original PR**
141+
142+
Link to the mainline branch version of this pull request, if any.
143+
144+
* **Risk**
145+
146+
What is the (specific) risk to the release for taking this change?
147+
148+
* **Testing**
149+
150+
What specific testing has been done or needs to be done to further validate
151+
any impact of this change?
152+
153+
* **Reviewers**
154+
155+
The code owners that approved the mainline branch pull request, if there is
156+
one.
157+
One or more code owners of the impacted components should approve the
158+
change.
159+
Technical review can be delegated by a code owner or otherwise requested as
160+
deemed appropriate or useful.
161+
```
162+
114163
### Code Review
115164

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

0 commit comments

Comments
 (0)