Skip to content

Commit 5128ee3

Browse files
committed
[NFC] Delete release branch PR template in favor of org-wide variant
`swiftlang` now has an equivalent organization-wide PR template, so we no longer need this local one.
1 parent 9e0b2e3 commit 5128ee3

File tree

2 files changed

+9
-26
lines changed

2 files changed

+9
-26
lines changed

.github/PULL_REQUEST_TEMPLATE/release_branch.md

-7
This file was deleted.

CONTRIBUTING.md

+9-19
Original file line numberDiff line numberDiff line change
@@ -85,28 +85,18 @@ In order for a pull request to be considered for inclusion in a release branch (
8585

8686
1. The title of the PR should start with the tag `[{swift version number}]`. For example, `[6.0]` for the Swift 6.0 release branch.
8787

88-
1. The PR description must include the following information:
89-
90-
```md
91-
* **Explanation**: A description of the issue being fixed or enhancement being made. This can be brief, but it should be clear.
92-
* **Scope**: An assessment of the impact/importance of the change. For example, is the change a source-breaking language change, etc.
93-
* **Issue**: The GitHub Issue link if the change fixes/implements an issue/enhancement.
94-
* **Original PR**: Pull Request link from the `main` branch.
95-
* **Risk**: What is the (specific) risk to the release for taking this change?
96-
* **Testing**: What specific testing has been done or needs to be done to further validate any impact of this change?
97-
* **Reviewer**: One or more code owners for the impacted components should review the change. Technical review can be delegated by a code owner or otherwise requested as deemed appropriate or useful.
98-
```
99-
100-
> [!TIP]
101-
> The PR description can be generated using the [release_branch.md](https://github.com/apple/swift-syntax/blob/main/.github/PULL_REQUEST_TEMPLATE/release_branch.md) [pull request template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates). To use this template when creating a PR, you need to add the query parameter:
102-
> ```
103-
> ?expand=1&template=release_branch.md
104-
> ```
105-
> to the PR URL, as described in the [GitHub documentation on using query parameters to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request).
106-
> This is necessary because GitHub does not currently provide a UI to choose a PR template.
88+
1. [This][form] filled out in the description of the PR.
89+
To use this template when creating a PR, append the `template=release.md`
90+
query parameter to the current URL and refresh.
91+
For example:
92+
```
93+
https://github.com/swiftlang/swift-syntax/compare/main...my-branch?quick_pull=1&template=release.md
94+
```
10795

10896
All changes going into a release branch must go through pull requests that are approved and merged by the corresponding release manager.
10997

98+
[form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1
99+
110100
## Review and CI Testing
111101

112102
After you opened your PR, a maintainer will review it and test your changes in CI (*Continuous Integration*) by adding a `@swift-ci Please test` comment on the pull request. Once your PR is approved and CI has passed, the maintainer will merge your pull request.

0 commit comments

Comments
 (0)