diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0bceb21..d9998d8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,6 +18,10 @@ Feel free to remove lines from this template that do not apply to you pull reque #### PR Checklist * [ ] If this is a work in progress PR, set as a Draft PR +* [ ] General + * [ ] Notebook is compatible with latest SimPEG release + * [ ] No deprecated functions and/or input arguments are being used + * [ ] Coding cells linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html). * [ ] Introduction is complete: * [ ] Title and author added to notebook * [ ] 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 * [ ] A header and short summary of what is being done * [ ] Links to API documentation added for all classes and functions that are used * [ ] Newly introduced functionality is explained, or links are provided to relevant materials - * [ ] The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged. + * [ ] The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged * [ ] All figures are legible and rendered appropriately - * [ ] Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html). * [ ] Marked as ready for review (if this is was a draft PR), and converted to a pull request -* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review. +* [ ] Tagged ``@simpeg/simpeg-developers`` when ready for review #### Additional information diff --git a/notebooks/contributing/pull_request.md b/notebooks/contributing/pull_request.md index 9276834..79d8026 100644 --- a/notebooks/contributing/pull_request.md +++ b/notebooks/contributing/pull_request.md @@ -8,6 +8,10 @@ Requirements Checklist The following is a useful checklist for determining whether the tutorial notebook has satisfied formatting and structure requirements: +* **General:** + * Notebook is compatible with latest SimPEG release + * No deprecated functions and/or input arguments are being used + * Coding cells linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html). * **The introduction is complete:** * Title and author added to notebook * 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 * A header and short summary of what is being done * Links to API documentation added for all classes and functions that are used * Newly introduced functionality is explained, or links are provided to relevant materials - * The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged. + * The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged * All figures are legible and rendered appropriately - * Coding cells have been linted according to the [style guides](https://docs.simpeg.xyz/latest/content/getting_started/contributing/code-style.html). Stages of a Pull Request ------------------------