Skip to content

Commit eed4dc8

Browse files
committed
update PR template
1 parent d08ad00 commit eed4dc8

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

.github/pull_request_template.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,24 @@ Feel free to remove lines from this template that do not apply to you pull reque
1414
-->
1515

1616
#### Summary
17-
<!-- Add a summary of this Pull Request -->
17+
<!-- Add a summary of this Pull Request. Explain what it provides as tutorial material. -->
1818

1919
#### PR Checklist
2020
* [ ] If this is a work in progress PR, set as a Draft PR
2121
* [ ] Introduction is complete:
22-
* [ ] Author has been added to notebook
23-
* [ ] An introductory paragraph summarizing the notebook's contents has been added
24-
* [ ] Appropriate admonitions for notebook difficulty and computational resources have been added
25-
* [ ] Appropriate keywords have been added
26-
* [ ] Learning objectives have been listed
27-
* [ ] Hyperlinks to other tutorial notebooks and important classes/functionality have been added
28-
* [ ] Each section is properly formatted
29-
* [ ] Short summary of what is being done
30-
* [ ] Newly introduced functionality is explained or a link is provided to a relevant notebook
31-
* [ ] Links to API documentation added for all classes and functionality
32-
* [ ] Data, models, etc... are plotted whenever possible
33-
* [ ] Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
34-
* [ ] Added [tests](https://docs.simpeg.xyz/latest/content/getting_started/contributing/testing.html) to verify changes to the code.
35-
* [ ] Marked as ready for review (if this is was a draft PR), and converted
36-
to a Pull Request
22+
* [ ] Title and author added to notebook
23+
* [ ] Admonitions for notebook difficulty and computational resources have been added
24+
* [ ] Keywords list has been added
25+
* [ ] Summary paragraph describing the tutorial has been added
26+
* [ ] Learning objectives have been listed
27+
* [ ] Hyperlinks to other tutorial notebooks added if necessary
28+
* [ ] For sections and subsections:
29+
* [ ] A header and short summary of what is being done
30+
* [ ] 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
32+
* [ ] All figures are legible and rendered appropriately
33+
* [ ] Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html).
34+
* [ ] Marked as ready for review (if this is was a draft PR), and converted to a pull request
3735
* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review.
3836

3937

0 commit comments

Comments
 (0)