Skip to content

CONTRIBUTING.md: Update for new Swift.org section about release branch PRs #1574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 2 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,22 +139,9 @@ Once you've pushed your branch, you should see an option on this repository's pa

## Opening a PR for Release Branch

In order for a pull request to be considered for inclusion in a release branch (e.g. `release/6.0`) after it has been cut, it must meet the following requirements:
See the [dedicated section][section] on the Swift project website.

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.

1. [This][form] should be filled out in the description of the PR.
To use this template when creating a PR, append the `template=release.md`
query parameter to the current URL and refresh.
For example:
```diff
-https://github.com/swiftlang/sourcekit-lsp/compare/main...my-branch?quick_pull=1
+https://github.com/swiftlang/sourcekit-lsp/compare/main...my-branch?quick_pull=1&template=release.md
```

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

[form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1
[section]: https://www.swift.org/contributing/#release-branch-pull-requests

## Review and CI Testing

Expand Down