Skip to content

Commit 794f7aa

Browse files
committed
Update checklist
1 parent 7762b25 commit 794f7aa

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Feel free to remove lines from this template that do not apply to you pull reque
1818

1919
#### PR Checklist
2020
* [ ] If this is a work in progress PR, set as a Draft PR
21+
* [ ] General
22+
* [ ] Notebook is compatible with latest SimPEG release
23+
* [ ] No deprecated functions and/or input arguments are being used
24+
* [ ] Coding cells linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
2125
* [ ] Introduction is complete:
2226
* [ ] Title and author added to notebook
2327
* [ ] Admonitions for notebook difficulty and computational resources have been added
@@ -29,11 +33,10 @@ Feel free to remove lines from this template that do not apply to you pull reque
2933
* [ ] A header and short summary of what is being done
3034
* [ ] Links to API documentation added for all classes and functions that are used
3135
* [ ] 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.
36+
* [ ] The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged
3337
* [ ] All figures are legible and rendered appropriately
34-
* [ ] Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
3538
* [ ] Marked as ready for review (if this is was a draft PR), and converted to a pull request
36-
* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review.
39+
* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review
3740

3841

3942
#### Additional information

notebooks/contributing/pull_request.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Requirements Checklist
88

99
The following is a useful checklist for determining whether the tutorial notebook has satisfied formatting and structure requirements:
1010

11+
* **General:**
12+
* Notebook is compatible with latest SimPEG release
13+
* No deprecated functions and/or input arguments are being used
14+
* Coding cells linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
1115
* **The introduction is complete:**
1216
* Title and author added to notebook
1317
* Admonitions for notebook difficulty and computational resources have been added
@@ -19,9 +23,8 @@ The following is a useful checklist for determining whether the tutorial noteboo
1923
* A header and short summary of what is being done
2024
* Links to API documentation added for all classes and functions that are used
2125
* 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.
26+
* The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged
2327
* All figures are legible and rendered appropriately
24-
* Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
2528

2629
Stages of a Pull Request
2730
------------------------

0 commit comments

Comments
 (0)