Skip to content

Commit 0b8db2c

Browse files
committed
[Markdown] Contributing: Add section about release branch PRs
In an effort to centralize information about the release process, including guidance on formatting a release branch pull request, dedicate a section to this for repositories and forum announcements to refer to.
1 parent f2fe939 commit 0b8db2c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

contributing/_contributing-code.md

+28
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,34 @@ 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` or `swift/release/x.y`)
117+
cannot be merged 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+
* [This][form] form filled out in its description. An item that is not
125+
applicable may be left blank or completed with an indication thereof, but must
126+
not be omitted altogether.
127+
128+
To switch to this template when drafting a pull request in a
129+
[swiftlang][swiftlang] repository in a browser, append the
130+
`template=release.md` query parameter to the current URL and refresh.
131+
For example:
132+
```diff
133+
-https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1
134+
+https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1&template=release.md
135+
```
136+
137+
[Here](https://github.com/apple/swift/pull/73697) is an example.
138+
139+
[swiftlang]: https://github.com/swiftlang
140+
[form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1
141+
114142
### Code Review
115143

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

0 commit comments

Comments
 (0)