Skip to content

Commit b30edf4

Browse files
RDILdaxian-dbw
authored andcommitted
Update the pull request template (PowerShell#8624)
Some cleanup/enhancements to make it easier to understand.
1 parent 71e58f9 commit b30edf4

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
<!-- Anything that looks like this is a comment and can't be seen after the Pull Request is created. -->
2+
13
## PR Summary
24

3-
<!-- summarize your PR between here and the checklist -->
5+
<!-- Summarize your PR between here and the checklist. -->
6+
7+
## PR Context
8+
9+
<!-- Provide a little reasoning as to why this Pull Request helps and why you have opened it. -->
410

511
## PR Checklist
612

@@ -10,14 +16,14 @@
1016
- [ ] [Change is not breaking](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)
1117
- [ ] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
1218
- [ ] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress).
13-
- If the PR is work in progress, please add the prefix `WIP:` to the beginning of the title and remove the prefix when the PR is ready.
19+
- If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready.
1420
- **User-facing changes**
1521
- [ ] Not Applicable
16-
- **OR**
17-
- [ ] User-facing [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
18-
- [ ] Issue filed - Issue link:
22+
- **OR**
23+
- [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
24+
- [ ] Issue filed: <!-- Number/link of that issue here -->
1925
- **Testing - New and feature**
20-
- [ ] Not Applicable or can only be tested interactively
26+
- [ ] N/A or can only be tested interactively
2127
- **OR**
2228
- [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting)
23-
- [ ] [Add `[feature]` if the change is significant or affects feature tests](https://github.com/PowerShell/PowerShell/blob/master/docs/testing-guidelines/testing-guidelines.md#requesting-additional-tests-for-a-pr)
29+
- [ ] [Add `[feature]` to your commit messages if the change is significant or affects feature tests](https://github.com/PowerShell/PowerShell/blob/master/docs/testing-guidelines/testing-guidelines.md#requesting-additional-tests-for-a-pr)

0 commit comments

Comments
 (0)