Skip to content

Commit 9d61b8f

Browse files
authored
Add a pull request template (#1)
Add a pull request template ### Motivation To help maintain consistency in pull request descriptions, and encourage PR authors to provide enough information to reviewers upfront, let's add a PR template to the repo. ### Modifications Added a PR template file based on the SwiftNIO one, with slight modifications (removed colons in headings, added a test plan section). Adjusted the NOTICE file to reflect that. ### Result PR authors will be presented with the template when creating a new PR using GitHub's UI or tools that support templates. ### Test Plan Well, this PR is already being open using the template :) Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #1
1 parent 2b329b7 commit 9d61b8f

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Motivation
2+
3+
_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
4+
5+
### Modifications
6+
7+
_[Describe the modifications you've made.]_
8+
9+
### Result
10+
11+
_[After your change, what will change.]_
12+
13+
### Test Plan
14+
15+
_[Describe the steps you took, or will take, to qualify the change - such as adjusting tests and manual testing.]_

NOTICE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ components that this product depends on.
2626

2727
-------------------------------------------------------------------------------
2828

29-
This product contains derivations of various scripts from SwiftNIO.
29+
This product contains derivations of various scripts and templates from SwiftNIO.
3030

3131
* LICENSE (Apache License 2.0):
3232
* https://www.apache.org/licenses/LICENSE-2.0

scripts/check-license-headers.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ read -ra PATHS_TO_CHECK_FOR_LICENSE <<< "$( \
4242
":(exclude).gitignore" \
4343
":(exclude).spi.yml" \
4444
":(exclude).swift-format" \
45+
":(exclude).github/*" \
4546
":(exclude)CODE_OF_CONDUCT.md" \
4647
":(exclude)CONTRIBUTING.md" \
4748
":(exclude)CONTRIBUTORS.txt" \

0 commit comments

Comments
 (0)