From 0b8db2c13bba6f143785662e3b6a0d656b513c1e Mon Sep 17 00:00:00 2001 From: Anthony Latsis Date: Tue, 4 Jun 2024 20:08:38 +0300 Subject: [PATCH] [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. --- contributing/_contributing-code.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/contributing/_contributing-code.md b/contributing/_contributing-code.md index 201a588ad..3a64f365b 100644 --- a/contributing/_contributing-code.md +++ b/contributing/_contributing-code.md @@ -111,6 +111,34 @@ For C or C++ source or header files, the code header should look this: 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. +### Release Branch Pull Requests + +A pull request targeting a release branch (`release/x.y` or `swift/release/x.y`) +cannot be merged without a GitHub approval by a corresponding branch manager. +In order for a change to be considered for inclusion in a release branch, the +pull request must have: + +* A title starting with a designation containing the release version number of + the target branch. + +* [This][form] form filled out in its description. An item that is not + applicable may be left blank or completed with an indication thereof, but must + not be omitted altogether. + + To switch to this template when drafting a pull request in a + [swiftlang][swiftlang] repository in a browser, append the + `template=release.md` query parameter to the current URL and refresh. + For example: + ```diff + -https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1 + +https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1&template=release.md + ``` + +[Here](https://github.com/apple/swift/pull/73697) is an example. + +[swiftlang]: https://github.com/swiftlang +[form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1 + ### Code Review The Swift project relies heavily on code review to improve software quality: