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: .github/ISSUE_TEMPLATE/BASICFORMAT_BUG.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ labels: [bug, BasicFormat]
4
4
body:
5
5
- type: markdown
6
6
attributes:
7
-
value: Thanks for taking the time to fill out this bug report! We would really appreciate if you could take the time to reduce the issue as described in [Filing BasicFormat Bug Reports](https://swiftpackageindex.com/apple/swift-syntax/main/documentation/swiftbasicformat/filingbugreports).
7
+
value: Thanks for taking the time to fill out this bug report! We would really appreciate if you could take the time to reduce the issue as described in [Filing BasicFormat Bug Reports](https://swiftpackageindex.com/swiftlang/swift-syntax/main/documentation/swiftbasicformat/filingbugreports).
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/PARSER_BUG.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,12 @@ labels: [bug, SwiftParser]
4
4
body:
5
5
- type: markdown
6
6
attributes:
7
-
value: Thanks for taking the time to fill out this bug report! We would really appreciate if you could take the time to reduce the issue as described in [Filing Parser Bug Reports](https://swiftpackageindex.com/apple/swift-syntax/main/documentation/swiftparser/filingbugreports).
7
+
value: Thanks for taking the time to fill out this bug report! We would really appreciate if you could take the time to reduce the issue as described in [Filing Parser Bug Reports](https://swiftpackageindex.com/swiftlang/swift-syntax/main/documentation/swiftparser/filingbugreports).
8
8
- type: dropdown
9
9
id: issue-type
10
10
attributes:
11
11
label: Issue Kind
12
-
description: What kind of issue is this? See [Filing Parser Bug Reports](https://swiftpackageindex.com/apple/swift-syntax/main/documentation/swiftparser/filingbugreports) for more details.
12
+
description: What kind of issue is this? See [Filing Parser Bug Reports](https://swiftpackageindex.com/swiftlang/swift-syntax/main/documentation/swiftparser/filingbugreports) for more details.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-20Lines changed: 14 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ swift-syntax is a SwiftPM package, so you can build and test it using anything t
19
19
20
20
## Formatting
21
21
22
-
swift-syntax is formatted using [swift-format](http://github.com/apple/swift-format) to ensure a consistent style.
22
+
swift-syntax is formatted using [swift-format](http://github.com/swiftlang/swift-format) to ensure a consistent style.
23
23
24
24
To format your changes run the formatter using the following command
25
25
```bash
@@ -79,34 +79,28 @@ For more information and instructions, read the GitHub docs on [forking a repo](
79
79
80
80
Once you've pushed your branch, you should see an option on this repository's page to create a PR from a branch in your fork.
81
81
82
+
> [!TIP]
83
+
> If you are stuck, it’s encouraged to submit a PR that describes the issue you’re having, e.g. if there are tests that are failing, build failures you can’t resolve, or if you have architectural questions. We’re happy to work with you to resolve those issue.
84
+
82
85
## Opening a PR for Release Branch
83
86
84
87
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:
85
88
86
89
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.
87
90
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.
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`
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