Skip to content

Commit ce20fd8

Browse files
authored
Merge pull request #1433 from AnthonyLatsis/prunus-persica
[NFC] Delete release branch PR template in favor of org-wide variant
2 parents d324d71 + 418e997 commit ce20fd8

File tree

2 files changed

+10
-26
lines changed

2 files changed

+10
-26
lines changed

.github/PULL_REQUEST_TEMPLATE/release_branch.md

-7
This file was deleted.

CONTRIBUTING.md

+10-19
Original file line numberDiff line numberDiff line change
@@ -143,28 +143,19 @@ In order for a pull request to be considered for inclusion in a release branch (
143143
144144
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.
145145
146-
1. The PR description must include the following information:
147-
148-
```md
149-
* **Explanation**: A description of the issue being fixed or enhancement being made. This can be brief, but it should be clear.
150-
* **Scope**: An assessment of the impact/importance of the change. For example, is the change a source-breaking language change, etc.
151-
* **Issue**: The GitHub Issue link if the change fixes/implements an issue/enhancement.
152-
* **Original PR**: Pull Request link from the `main` branch.
153-
* **Risk**: What is the (specific) risk to the release for taking this change?
154-
* **Testing**: What specific testing has been done or needs to be done to further validate any impact of this change?
155-
* **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.
156-
```
157-
158-
> [!TIP]
159-
> The PR description can be generated using the [release_branch.md](https://github.com/swiftlang/sourcekit-lsp/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:
160-
> ```
161-
> ?expand=1&template=release_branch.md
162-
> ```
163-
> 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).
164-
> This is necessary because GitHub does not currently provide a UI to choose a PR template.
146+
1. [This][form] should be filled out in the description of the PR.
147+
To use this template when creating a PR, append the `template=release.md`
148+
query parameter to the current URL and refresh.
149+
For example:
150+
```diff
151+
-https://github.com/swiftlang/sourcekit-lsp/compare/main...my-branch?quick_pull=1
152+
+https://github.com/swiftlang/sourcekit-lsp/compare/main...my-branch?quick_pull=1&template=release.md
153+
```
165154
166155
All changes going into a release branch must go through pull requests that are approved and merged by the corresponding release manager.
167156
157+
[form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1
158+
168159
## Review and CI Testing
169160
170161
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)