Skip to content

Commit 008aba7

Browse files
committed
Reduce boilerplate in the GitHub PR template
1 parent ddf31e6 commit 008aba7

File tree

3 files changed

+17
-67
lines changed

3 files changed

+17
-67
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+10-65
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,13 @@
1-
<!-- Please complete this template before creating the pull request. -->
2-
#### What's in this pull request?
3-
<!-- Description about pull request. -->
1+
<!-- What's in this pull request? -->
2+
Replace this paragraph with a description of your changes and rationale. Provide links to external references/discussions if appropriate.
43

5-
#### Resolved bug number: ([SR-](https://bugs.swift.org/browse/SR-))
6-
<!-- If this pull request resolves any bugs from Swift bug tracker -->
4+
<!-- If this pull request resolves any bugs in the Swift bug tracker, provide a link: -->
5+
Resolves [SR-NNNN](https://bugs.swift.org/browse/SR-NNNN).
76

8-
* * * *
7+
<!--
8+
Before merging this pull request, you must run the Swift continuous integration tests.
9+
For information about triggering CI builds via @swift-ci, see:
10+
https://github.com/apple/swift/blob/master/docs/ContinuousIntegration.md#swift-ci
911
10-
<!-- This selection should only be completed by Swift admin -->
11-
Before merging this pull request to apple/swift repository:
12-
- [ ] Test pull request on Swift continuous integration.
13-
14-
<details>
15-
<summary>Triggering Swift CI</summary>
16-
17-
The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:
18-
19-
**Smoke Testing**
20-
21-
Platform | Comment
22-
------------ | -------------
23-
All supported platforms | @swift-ci Please smoke test
24-
All supported platforms | @swift-ci Please smoke test and merge
25-
OS X platform | @swift-ci Please smoke test OS X platform
26-
Linux platform | @swift-ci Please smoke test Linux platform
27-
28-
A smoke test on macOS does the following:
29-
30-
1. Builds the compiler incrementally.
31-
2. Builds the standard library only for macOS. Simulator standard libraries and
32-
device standard libraries are not built.
33-
3. lldb is not built.
34-
4. The test and validation-test targets are run only for macOS. The optimized
35-
version of these tests are not run.
36-
37-
A smoke test on Linux does the following:
38-
39-
1. Builds the compiler incrementally.
40-
2. Builds the standard library incrementally.
41-
3. lldb is built incrementally.
42-
4. The swift test and validation-test targets are run. The optimized version of these
43-
tests are not run.
44-
5. lldb is tested.
45-
46-
**Validation Testing**
47-
48-
Platform | Comment
49-
------------ | -------------
50-
All supported platforms | @swift-ci Please test
51-
All supported platforms | @swift-ci Please clean test
52-
All supported platforms | @swift-ci Please test and merge
53-
OS X platform | @swift-ci Please test OS X platform
54-
OS X platform | @swift-ci Please clean test OS X platform
55-
OS X platform | @swift-ci Please benchmark
56-
Linux platform | @swift-ci Please test Linux platform
57-
Linux platform | @swift-ci Please clean test Linux platform
58-
59-
60-
**Lint Testing**
61-
62-
Language | Comment
63-
------------ | -------------
64-
Python | @swift-ci Please Python lint
65-
66-
Note: Only members of the Apple organization can trigger swift-ci.
67-
</details>
68-
<!-- Thank you for your contribution to Swift! -->
12+
Thank you for your contribution to Swift!
13+
-->

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ license](https://swift.org/LICENSE.txt).
55

66
---
77

8-
Before submitting the pull request, please make sure you have tested your
9-
changes and that they follow the Swift project [guidelines for contributing
8+
Before submitting the pull request, please make sure you have [tested your
9+
changes](https://github.com/apple/swift/blob/master/docs/ContinuousIntegration.md)
10+
and that they follow the Swift project [guidelines for contributing
1011
code](https://swift.org/contributing/#contributing-code).

docs/ContinuousIntegration.md

+4
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,13 @@ A smoke test on Linux does the following:
6767
Platform | Comment
6868
------------ | -------------
6969
All supported platforms | @swift-ci Please test
70+
All supported platforms | @swift-ci Please clean test
7071
All supported platforms | @swift-ci Please test and merge
7172
OS X platform | @swift-ci Please test OS X platform
73+
OS X platform | @swift-ci Please clean test OS X platform
74+
OS X platform | @swift-ci Please benchmark
7275
Linux platform | @swift-ci Please test Linux platform
76+
Linux platform | @swift-ci Please clean test Linux platform
7377

7478
The core principles of validation testing is that:
7579

0 commit comments

Comments
 (0)