Skip to content

Commit b2ddddd

Browse files
authored
Merge pull request #50 from NOAA-EDAB/chore/i49_pr_template
Chore/i49 pr template
2 parents a81ec73 + dfc148f commit b2ddddd

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Your commits explain the `what` and `where` you made changes in the code. Your commit messages explain `why` you made the commits. You do not need to reiterate this. This PR is meant to address the big picture, `Why`
2+
3+
### Justification
4+
5+
Describe the big picture of your changes here to communicate to the reviewers why they should accept this pull request.
6+
Please describe the importance/impact of the problem and a description of how the changes in this pull request will address, resolve or improve the problem.
7+
If it fixes a bug or resolves a feature request, be sure to link to the issue below
8+
9+
### Types of changes
10+
11+
What types of changes does your code introduce? Put an `x` in the boxes that apply
12+
13+
- [ ] Bugfix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation Update (if none of the other choices apply)
17+
18+
### Checklist/Reminders
19+
20+
Put an `x` in the boxes that apply
21+
22+
- [ ] I have updated relevant documentation?
23+
- [ ] I have tested my changes?
24+
- [ ] I have created unit tests and run `devtools::test()` to ensure all unit tests pass locally?
25+
- [ ] I have run `devtools::check()` to ensure package builds locally?
26+
- [ ] I have followed the proposed [CONTRIBUTING](../blob/main/CONTRIBUTING.md) guideline?
27+
28+
### Further comments
29+
30+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
31+
32+
### Reviewer instructions:
33+
34+
Assign at least 2 reviewers:
35+
* one of which should be a maintainer,
36+
* the others should be familiar with the subject changes.
37+
38+
Please detail the process reviewers will need to follow to properly test these changes. It is especially helpful to identify the exact code needed to conduct a local build/review/test and to specify any aspects of the testing that may not be obvious.

0 commit comments

Comments
 (0)