Skip to content

Commit 544cb9c

Browse files
authored
Revise pull request template for better guidance
Ensure that linked issues are actually connected in GitHub and subsequently closed when the PR is merged by prepending the issue number with "Resolves". Also simplifies the formatting.
1 parent 6642a41 commit 544cb9c

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,49 @@
1-
<!--- Provide a general summary of your changes in the Title above -->
1+
<!-- Provide a general summary of your changes in the Title above -->
22

33
## Description
44

5-
<!--- Describe your changes in detail -->
5+
<!-- Describe your changes in detail -->
66

77
## Related Issue
88

9-
<!--- This project only accepts pull requests related to open issues -->
9+
<!--
1010
11-
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
11+
This project only accepts pull requests related to open issues.
12+
If suggesting a new feature or change, please discuss it in an issue first.
13+
If fixing a bug, there should be an issue describing it with steps to reproduce.
14+
Please replace "XYZ" below with the issue number that is being resolved by this
15+
pull request.
1216
13-
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
17+
-->
1418

15-
<!--- Please link to the issue here: -->
19+
Resolves #XYZ
1620

1721
## Motivation and Context
1822

19-
<!--- Why is this change required? What problem does it solve? -->
23+
<!-- Why is this change required? What problem does it solve? -->
2024

2125
## How Has This Been Tested?
2226

23-
<!--- Please describe in detail how you tested your changes. -->
27+
<!--
2428
25-
<!--- Include details of your testing environment, and the tests you ran to -->
29+
Include details of your testing environment, and the tests you ran to
30+
see how your change affects other areas of the code, etc.
31+
Please describe in detail how you tested your changes.
2632
27-
<!--- see how your change affects other areas of the code, etc. -->
33+
-->
2834

2935
## Screenshots (if appropriate):
3036

31-
<!--- Drag and drop screenshots here -->
37+
<!-- Drag and drop screenshots here -->
3238

3339
## Checklist:
3440

35-
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
41+
<!--
3642
37-
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
43+
Go over all the following points, and put an `x` in all the boxes that apply.
44+
If you're unsure about any of these, don't hesitate to ask. We're here to help!
45+
46+
-->
3847

3948
* \[ ] My code follows the code style of this project.
4049
* \[ ] My change requires a change to the documentation.

0 commit comments

Comments
 (0)