Skip to content

Commit 0b58eaa

Browse files
authored
Merge pull request #339 from rstudio/update-pull-request-template
Update the GitHub pull request template.
2 parents 802a761 + 8f62112 commit 0b58eaa

File tree

1 file changed

+31
-17
lines changed

1 file changed

+31
-17
lines changed

.github/pull_request_template.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1-
### Description
1+
<!--- Provide a general summary of your changes in the title. -->
22

3-
> Include a brief description of the problem being solved and why this
4-
> approach was chosen. Mention risks or shortcomings with this solution.
5-
> Provide relevant background information such as the associated issue, links
6-
> to design documents, screenshots, and performance measurements.
7-
>
8-
> Even small changes deserve a little attention to detail. Put your change in
9-
> context.
3+
## Description
4+
<!--- Please describe the problem you are addressing and your proposed changes. -->
105

11-
Connected to #
6+
## Motivation and Context
7+
<!--- Even small changes deserve a little attention to detail. -->
8+
<!--- Why is this change required? What problem does it solve? -->
9+
<!--- If it fixes an open issue, please link to the issue here. -->
10+
<!--- Example: "Addresses Issue # 1" -->
1211

13-
### Testing Notes / Validation Steps
12+
## How Has This Been Tested?
13+
<!--- Please describe in detail how you tested your changes. -->
14+
<!--- Automation should be used to verify that a change remains in place. -->
15+
<!--- Automated tests should be included in this pull request. -->
1416

15-
> Explain how this change has been tested and what cases/conditions are
16-
> covered. Enumerate the steps someone might take to manually exercise this
17-
> change. Detail is important!
18-
>
19-
> You can recommend one-time manual testing when someone validates your
20-
> changes. Rely on automation when trying to verify that a change remains in
21-
> place. Automated tests should be included in this PR.
17+
<!--- If applicable, enumerate the steps that someone can take to exercise this change manually. -->
18+
<!--- Please include details of your testing environment. -->
19+
<!--- Detail is important! -->
20+
21+
### Screenshots (if appropriate):
22+
23+
## Types of Changes
24+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
25+
- [ ] Bug fix (non-breaking change which fixes an issue)
26+
- [ ] New feature (non-breaking change which adds functionality)
27+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
28+
29+
## Checklist:
30+
<!--- Go over all the following points, and put an `x` in all the boxes that apply: -->
31+
<!--- If you need clarification on any of these, feel free to ask. We're here to help! -->
32+
- [ ] I have read the **CONTRIBUTING** document.
33+
- [ ] My code follows the code style of this project.
34+
- [ ] I have updated the documentation as needed.
35+
- [ ] I have added tests to cover my changes.

0 commit comments

Comments
 (0)