Skip to content

Commit 7762b25

Browse files
committed
update template
1 parent 18fda61 commit 7762b25

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Feel free to remove lines from this template that do not apply to you pull reque
2828
* [ ] For sections and subsections:
2929
* [ ] A header and short summary of what is being done
3030
* [ ] Links to API documentation added for all classes and functions that are used
31-
* [ ] Newly introduced functionality is explained or links provided to relevant notebooks
31+
* [ ] Newly introduced functionality is explained, or links are provided to relevant materials
32+
* [ ] The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged.
3233
* [ ] All figures are legible and rendered appropriately
3334
* [ ] Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
3435
* [ ] Marked as ready for review (if this is was a draft PR), and converted to a pull request

notebooks/contributing/pull_request.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ The following is a useful checklist for determining whether the tutorial noteboo
1818
* **For sections and subsections:**
1919
* A header and short summary of what is being done
2020
* Links to API documentation added for all classes and functions that are used
21-
* Newly introduced functionality is explained or links provided to relevant notebooks
21+
* Newly introduced functionality is explained, or links are provided to relevant materials
22+
* The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged.
2223
* All figures are legible and rendered appropriately
2324
* Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
2425

0 commit comments

Comments
 (0)