From ef6e7968973da04455304f8d94b24a86ea970bd5 Mon Sep 17 00:00:00 2001 From: HaleySchuhl Date: Fri, 22 Aug 2025 13:22:22 -0500 Subject: [PATCH 1/4] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d1e214e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +**Describe your changes** +A clear and concise description of what changes are made by this pull request. +What was the previous functionality (if relevant) and what can we do now with +these changes. + +**Type of update** +Is this a: +* Bug fix +* New feature or feature enhancement +* Update to documentation +* Work in progress + +**Associated issues** +Reference associated issue numbers. Does this pull request close any issues? + +**Additional context** +Add any other context about the problem here. + +**For the reviewer** +- [ ] +- [ ] Test passes (ci-tests.yml enabled) +- [ ] Code reviewed +- [ ] PR approved +- [ ] Merge PR +- [ ] PR Binder environment built From a93e0f174eb091522dce7cf2bfe20859bfcd70dc Mon Sep 17 00:00:00 2001 From: HaleySchuhl Date: Fri, 22 Aug 2025 13:41:59 -0500 Subject: [PATCH 2/4] finish making checklist for reviewer --- .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d1e214e..205e162 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,24 @@ **Describe your changes** A clear and concise description of what changes are made by this pull request. -What was the previous functionality (if relevant) and what can we do now with -these changes. **Type of update** Is this a: -* Bug fix -* New feature or feature enhancement -* Update to documentation +* Workflow update +* Update to documentation (markdown/code comments) * Work in progress **Associated issues** Reference associated issue numbers. Does this pull request close any issues? **Additional context** -Add any other context about the problem here. +Add any other context here. **For the reviewer** -- [ ] -- [ ] Test passes (ci-tests.yml enabled) -- [ ] Code reviewed +- [ ] Assign yourself a reviewer +- [ ] Test passes (if no test run, enable `.github/workflows/ci-tests.yml`) +- [ ] Changes reviewed +- [ ] Workflow/Documentation updates made to both `index.ipynb` and `index-Colab.ipynb` - [ ] PR approved - [ ] Merge PR - [ ] PR Binder environment built +- [ ] If PR author is a new contributor, add to plantcv with a comment like [this](https://github.com/danforthcenter/plantcv/pull/1737#issuecomment-3084551747) From 3bf2aed5d817bb9bef022969c774a739bc0044f4 Mon Sep 17 00:00:00 2001 From: HaleySchuhl Date: Fri, 22 Aug 2025 13:51:24 -0500 Subject: [PATCH 3/4] clarify how and why to build the binder env after merging updates --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 205e162..16c074b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,5 +20,7 @@ Add any other context here. - [ ] Workflow/Documentation updates made to both `index.ipynb` and `index-Colab.ipynb` - [ ] PR approved - [ ] Merge PR -- [ ] PR Binder environment built +- [ ] Binder environment built* - [ ] If PR author is a new contributor, add to plantcv with a comment like [this](https://github.com/danforthcenter/plantcv/pull/1737#issuecomment-3084551747) + +* To build a binder environment after changes are pushed are merged into main, click on the [launch binder] button in the README.md. A repository usually takes a long time to launch after updates because Binder needs to create the environment. This step aims to provide quicker launches to users. From feda49e2df009a54377c10e2f40c646f86d73c33 Mon Sep 17 00:00:00 2001 From: HaleySchuhl Date: Fri, 22 Aug 2025 13:55:17 -0500 Subject: [PATCH 4/4] escape markdown for star --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 16c074b..0c9d1ef 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,4 +23,4 @@ Add any other context here. - [ ] Binder environment built* - [ ] If PR author is a new contributor, add to plantcv with a comment like [this](https://github.com/danforthcenter/plantcv/pull/1737#issuecomment-3084551747) -* To build a binder environment after changes are pushed are merged into main, click on the [launch binder] button in the README.md. A repository usually takes a long time to launch after updates because Binder needs to create the environment. This step aims to provide quicker launches to users. +\* To build a binder environment after changes are pushed are merged into main, click on the [launch binder] button in the README.md. A repository usually takes a long time to launch after updates because Binder needs to create the environment. This step aims to provide quicker launches to users.