Skip to content

Commit

Permalink
Merge pull request #131 from microbiomedata/130_PR_template_update
Browse files Browse the repository at this point in the history
Update PR template
  • Loading branch information
kheal authored Feb 13, 2025
2 parents b1b0790 + 15d1886 commit cf7aa6e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,22 @@

### New Notebook Submissions:

* [ ] Have you included a summary of the notebook in the README.md included updated links to the notebook?
* [ ] Does your PR include links to the new notebook **(in the branch)** for review using [nbviewer](https://nbviewer.jupyter.org/), [Colab](https://colab.research.google.com/), and [reviewnb](https://www.reviewnb.com/)? These three are the preferred ways to review changes and additions to notebooks during review.
* [ ] Have you included a summary of the notebook in the README.md included updated links to the notebook? The links in the README.md should point to where the notebooks will live once they are merged into the **main** branch.
* [ ] Does your PR include links to the new notebook **(in the branch)** for review using [nbviewer](https://nbviewer.jupyter.org/), and [Colab](https://colab.research.google.com/)? These are the preferred ways to review changes and additions to notebooks during review.
* [ ] Does your PR include a test in a github workflow that tests the render-ability of your notebook?

### Notebook Fix Submissions:
* [ ] Does your PR include links to the updated notebook **(in the branch)** for review using [nbviewer](https://nbviewer.jupyter.org/), and [Colab](https://colab.research.google.com/)? These are the preferred ways to review changes and additions to notebooks during review. See the guidance below for how to create these links.

* [ ] Does your PR include links to the updated notebook **(in the branch)** for review using [nbviewer](https://nbviewer.jupyter.org/), [Colab](https://colab.research.google.com/), and [reviewnb](https://www.reviewnb.com/)? These three are the preferred ways to review changes and additions to notebooks during review.
### Guidance for creating links to notebooks in the README.md
* To create a Colab link for your notebook for review, use the following format:
```
https://colab.research.google.com/github/microbiomedata/nmdc_notebooks/blob/your_branch/folder1/folder2/your_notebook.ipynb
```
Replace `your_branch` with the branch name, `folder1` and `folder2` with the path to your notebook folder, and `your_notebook.ipynb` with the name of your notebook file.
* To create a nbviewer link for your notebook for review, use the following format:
```
https://nbviewer.org/github/microbiomedata/nmdc_notebooks/blob/your_branch/folder1/folder2/your_notebook.ipynb
```
Replace `your_branch` with the branch name, `folder1` and `folder2` with the path to your notebook folder, and `your_notebook.ipynb` with the name of your notebook file.

0 comments on commit cf7aa6e

Please sign in to comment.