Skip to content

Commit 0d7dc6e

Browse files
committed
added minor changes doc; update PR template
1 parent e73fbdd commit 0d7dc6e

3 files changed

Lines changed: 22 additions & 1 deletion

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Make sure all the relevant boxes are checked (and only check the box if you actu
55
- [ ] New tests added (describe which tests were performed to test the changes)
66
- [ ] Science test figures (add figures to PR comment and describe the tests)
77
- [ ] 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 (found here: `./summa/docs/whats-new.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)