Skip to content

Commit fa9adf8

Browse files
authored
Merge pull request #505 from CH-Earth/pr_template_update
updated PR template
2 parents 372c3fb + 0d7dc6e commit fa9adf8

3 files changed

Lines changed: 27 additions & 6 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Make sure all the relevant boxes are checked (and only check the box if you actually completed the step):
22

3-
- [ ] closes #xxx (identify the issue associated with this PR)
4-
- [ ] tests passed
5-
- [ ] new tests added
6-
- [ ] science test figures
7-
- [ ] checked that the new code conforms to the [SUMMA coding conventions](https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md)
8-
- [ ] ReleaseNotes entry
3+
- [ ] Closes #xxx (identify the issue associated with this PR)
4+
- [ ] Code passes standard test cases (results are either bit-for-bit identical, or differences are explained in the PR comment)
5+
- [ ] New tests added (describe which tests were performed to test the changes)
6+
- [ ] Science test figures (add figures to PR comment and describe the tests)
7+
- [ ] Checked that the new code conforms to the [SUMMA coding conventions](https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md)
8+
- [ ] Describe the change in the release notes (use either `./summa/docs/whats-new.md` or `./summa/docs/minor-changes.md` depending on what changed)

docs/minor-changes.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Minor changes
2+
3+
This page provides simple, high-level documentation about what has changed in each new release of SUMMA.
4+
5+
Documented here are minor changes that do not affect science outputs or are likely to affect only a minority of users:
6+
- Minor bugfixes
7+
- Correction of misspellings
8+
- Changes to formatting
9+
- Addition of print statements
10+
- Etc.
11+
12+
## Version 3.0.4 (pre-release)
13+
14+
- [placeholder]

docs/whats-new.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
This page provides simple, high-level documentation about what has changed in each new release of SUMMA.
44

5+
Documented here are large changes that will likely affect the majority of users:
6+
- New features
7+
- Changes to the functionality of the code
8+
- Changes to default settings
9+
- Changes in code conventions (e.g. variable renaming)
10+
- Etc.
11+
512
## Version 3.0.4 (pre-release)
613

714
- Initial addition of the "What's new" page

0 commit comments

Comments
 (0)