Skip to content

Commit dae4eed

Browse files
committed
New PR template added
1 parent e6d2472 commit dae4eed

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!--
2+
Thanks for contributing a pull request to SimPEG user tutorials!
3+
Remember to use a personal fork of SimPEG user tutorials to propose changes.
4+
5+
Check out the stages of a pull request at
6+
https://docs.simpeg.xyz/content/getting_started/contributing/pull-requests.html
7+
8+
Note that we are a team of volunteers and we appreciate your
9+
patience during the review process.
10+
11+
Again, thanks for contributing!
12+
13+
Feel free to remove lines from this template that do not apply to you pull request.
14+
-->
15+
16+
#### Summary
17+
<!-- Add a summary of this Pull Request -->
18+
19+
#### PR Checklist
20+
* [ ] If this is a work in progress PR, set as a Draft PR
21+
* [ ] 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
37+
* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review.
38+
39+
40+
#### Additional information
41+
<!--Any additional information you think is important.-->
42+
43+
44+
<!--
45+
Once all tests pass and the code has been reviewed and approved, it will be merged into main
46+
-->

0 commit comments

Comments
 (0)