Skip to content

Commit 063d7d7

Browse files
committed
[Markdown] Contributing: Add section about release branch PRs
In an effort to centralize the release branch PR form and release process info in general, dedicate a section to this for repositories and forum announcements to refer to instead of each publishing their own copies.
1 parent f2fe939 commit 063d7d7

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

contributing/_contributing-code.md

+29
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,35 @@ 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+
A pull request targeting a release branch (`release/x.y`) cannot be merged
117+
without an approval by the corresponding release manager.
118+
In order for a change to be considered for inclusion in a release branch, the
119+
pull request must have:
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**: A description of the change. This can be brief, but it
128+
should be clear.
129+
- **Scope**: An assessment of the impact and importance of the change. For
130+
example, is the change a source-breaking language change?
131+
- **Issues**: References to issues the change resolves, if any.
132+
- **Original PRs**: Links to the mainline branch pull requests, the changes
133+
from which make up this pull request, if any.
134+
- **Risk**: The (specific) risk to the release for taking this change.
135+
- **Testing**: The specific testing that has been done or needs to be done to
136+
further validate any impact of this change.
137+
- **Reviewers**: The code owners that approved the mainline branch pull
138+
requests. If any part of the mainline branch changes was not approved by a
139+
respective code owner, provide a reason. Technical review can be delegated
140+
by a code owner or otherwise requested as deemed appropriate or useful.
141+
```
142+
114143
### Code Review
115144

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

0 commit comments

Comments
 (0)