8000 Merge pull request #2669 from AnthonyLatsis/prunus-persica · Matejkob/swift-syntax@5c1adb9 · GitHub
  • [go: up one dir, main page]

    Skip to content

    Commit 5c1adb9

    Browse files
    authored
    Merge pull request swiftlang#2669 from AnthonyLatsis/prunus-persica
    [NFC] Delete release branch PR template in favor of org-wide variant
    2 parents a505051 + e42963d commit 5c1adb9

    File tree

    2 files changed

    +10
    -26
    lines changed

    2 files changed

    +10
    -26
    lines changed

    .github/PULL_REQUEST_TEMPLATE/release_branch.md

    Lines changed: 0 additions & 7 deletions
    This file was deleted.

    CONTRIBUTING.md

    Lines changed: 10 additions & 19 deletions
    Original file line numberDiff line numberDiff line change
    @@ -88,28 +88,19 @@ In order for a pull request to be considered for inclusion in a release branch (
    8888

    8989
    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.
    9090

    91-
    1. The PR description must include the following information:
    92-
    93-
    ```md
    94-
    * **Explanation**: A description of the issue being fixed or enhancement being made. This can be brief, but it should be clear.
    95-
    * **Scope**: An assessment of the impact/importance of the change. For example, is the change a source-breaking language change, etc.
    96-
    * **Issue**: The GitHub Issue link if the change fixes/implements an issue/enhancement.
    97-
    * **Original PR**: Pull Request link from the `main` branch.
    98-
    * **Risk**: What is the (specific) risk to the release for taking this change?
    99-
    * **Testing**: What specific testing has been done or needs to be done to further validate any impact of this change?
    100-
    * **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.
    101-
    ```
    102-
    103-
    > [!TIP]
    104-
    > 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:
    105-
    > ```
    106-
    > ?expand=1&template=release_branch.md
    107-
    > ```
    108-
    > 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).
    109-
    > This is necessary because GitHub does not currently provide a UI to choose a PR template.
    91+
    1. [This][form] should be filled out in the description of the PR.
    92+
    To use this template when creating a PR, append the `template=release.md`
    93+
    query parameter to the current URL and refresh.
    94+
    For example:
    95+
    ```diff
    96+
    -https://github.com/swiftlang/swift-syntax/compare/main...my-branch?quick_pull=1
    97+
    +https://github.com/swiftlang/swift-syntax/compare/main...my-branch?quick_pull=1&template=release.md
    98+
    ```
    11099

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

    102+
    [form]: https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1
    103+
    113104
    ## Review and CI Testing
    114105

    115106
    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)
    0