You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+10-19
Original file line number
Diff line number
Diff line change
@@ -143,28 +143,19 @@ In order for a pull request to be considered for inclusion in a release branch (
143
143
144
144
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.
145
145
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`
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