diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a549804c1cb..bbae6891287 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,68 +1,13 @@ - -#### What's in this pull request? - + +Replace this paragraph with a description of your changes and rationale. Provide links to external references/discussions if appropriate. -#### Resolved bug number: ([SR-](https://bugs.swift.org/browse/SR-)) - + +Resolves [SR-NNNN](https://bugs.swift.org/browse/SR-NNNN). -* * * * + -Before merging this pull request to apple/swift repository: -- [ ] Test pull request on Swift continuous integration. - -
- Triggering Swift CI - -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: - -**Smoke Testing** - - Platform | Comment - ------------ | ------------- - All supported platforms | @swift-ci Please smoke test - All supported platforms | @swift-ci Please smoke test and merge - OS X platform | @swift-ci Please smoke test OS X platform - Linux platform | @swift-ci Please smoke test Linux platform - -A smoke test on macOS does the following: - -1. Builds the compiler incrementally. -2. Builds the standard library only for macOS. Simulator standard libraries and - device standard libraries are not built. -3. lldb is not built. -4. The test and validation-test targets are run only for macOS. The optimized - version of these tests are not run. - -A smoke test on Linux does the following: - -1. Builds the compiler incrementally. -2. Builds the standard library incrementally. -3. lldb is built incrementally. -4. The swift test and validation-test targets are run. The optimized version of these - tests are not run. -5. lldb is tested. - -**Validation Testing** - - Platform | Comment - ------------ | ------------- - All supported platforms | @swift-ci Please test - All supported platforms | @swift-ci Please clean test - All supported platforms | @swift-ci Please test and merge - OS X platform | @swift-ci Please test OS X platform - OS X platform | @swift-ci Please clean test OS X platform - OS X platform | @swift-ci Please benchmark - Linux platform | @swift-ci Please test Linux platform - Linux platform | @swift-ci Please clean test Linux platform - - -**Lint Testing** - - Language | Comment - ------------ | ------------- - Python | @swift-ci Please Python lint - -Note: Only members of the Apple organization can trigger swift-ci. -
- +Thank you for your contribution to Swift! +--> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e36bf969f0c..0283424f6b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,7 @@ license](https://swift.org/LICENSE.txt). --- -Before submitting the pull request, please make sure you have tested your -changes and that they follow the Swift project [guidelines for contributing +Before submitting the pull request, please make sure you have [tested your +changes](https://github.com/apple/swift/blob/master/docs/ContinuousIntegration.md) +and that they follow the Swift project [guidelines for contributing code](https://swift.org/contributing/#contributing-code). diff --git a/docs/ContinuousIntegration.md b/docs/ContinuousIntegration.md index 8a2a713646e..74c8d6bdc18 100644 --- a/docs/ContinuousIntegration.md +++ b/docs/ContinuousIntegration.md @@ -67,9 +67,13 @@ A smoke test on Linux does the following: Platform | Comment ------------ | ------------- All supported platforms | @swift-ci Please test + All supported platforms | @swift-ci Please clean test All supported platforms | @swift-ci Please test and merge OS X platform | @swift-ci Please test OS X platform + OS X platform | @swift-ci Please clean test OS X platform + OS X platform | @swift-ci Please benchmark Linux platform | @swift-ci Please test Linux platform + Linux platform | @swift-ci Please clean test Linux platform The core principles of validation testing is that: