Merge pull request #505 from CH-Earth/pr_template_update

updated PR template
CH-Earth · Mar 15, 2022 · fa9adf8 · fa9adf8
2 parents 372c3fb + 0d7dc6e
commit fa9adf8
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,8 @@
 Make sure all the relevant boxes are checked (and only check the box if you actually completed the step):
 
-- [ ] closes #xxx (identify the issue associated with this PR)
-- [ ] tests passed
-- [ ] new tests added
-- [ ] science test figures
-- [ ] checked that the new code conforms to the [SUMMA coding conventions](https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md)
-- [ ] ReleaseNotes entry
+- [ ] Closes #xxx (identify the issue associated with this PR)
+- [ ] Code passes standard test cases (results are either bit-for-bit identical, or differences are explained in the PR comment)
+- [ ] New tests added (describe which tests were performed to test the changes)
+- [ ] Science test figures (add figures to PR comment and describe the tests)
+- [ ] Checked that the new code conforms to the [SUMMA coding conventions](https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md)
+- [ ] Describe the change in the release notes (use either `./summa/docs/whats-new.md` or `./summa/docs/minor-changes.md` depending on what changed)
diff --git a/docs/minor-changes.md b/docs/minor-changes.md
@@ -0,0 +1,14 @@
+# Minor changes
+
+This page provides simple, high-level documentation about what has changed in each new release of SUMMA.
+
+Documented here are minor changes that do not affect science outputs or are likely to affect only a minority of users:
+- Minor bugfixes
+- Correction of misspellings
+- Changes to formatting
+- Addition of print statements
+- Etc. 
+
+## Version 3.0.4 (pre-release)
+
+- [placeholder]
diff --git a/docs/whats-new.md b/docs/whats-new.md
@@ -2,6 +2,13 @@
 
 This page provides simple, high-level documentation about what has changed in each new release of SUMMA.
 
+Documented here are large changes that will likely affect the majority of users:
+- New features
+- Changes to the functionality of the code
+- Changes to default settings
+- Changes in code conventions (e.g. variable renaming)
+- Etc.
+
 ## Version 3.0.4 (pre-release)
 
 - Initial addition of the "What's new" page