Skip to content

Commit 43a80d1

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 43a80d1

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

contributing/_contributing-code.md

+35
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,41 @@ 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 a GitHub approval by a corresponding branch 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 starting with a designation containing the release version number of
122+
the target branch.
123+
124+
* The following form filled out in its description:
125+
126+
```
127+
- **Explanation**: A description of the changes. This can be brief, but it
128+
should be clear.
129+
- **Scope**: An assessment of the impact and importance of the changes. For
130+
example, can the changes break existing code?
131+
- **Issues**: References to issues the changes resolve, if any.
132+
- **Original PRs**: Links to mainline branch pull requests in which the
133+
changes originated.
134+
- **Risk**: The (specific) risk to the release for taking the changes.
135+
- **Testing**: The specific testing that has been done or needs to be done to
136+
further validate any impact of the changes.
137+
- **Reviewers**: The code owners that GitHub-approved the original changes in
138+
the mainline branch pull requests. If an original change has not been
139+
GitHub-approved by a respective code owner, provide a reason. Technical
140+
review can be delegated by a code owner or otherwise requested as deemed
141+
appropriate or useful.
142+
```
143+
144+
An item that is not applicable may be left blank or completed with an
145+
indication thereof, but must not be omitted altogether.
146+
147+
[Here](https://github.com/apple/swift/pull/73697) is an example.
148+
114149
### Code Review
115150

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

0 commit comments

Comments
 (0)