From 39119adffb550358db6a167df0da753f920b7953 Mon Sep 17 00:00:00 2001 From: Brett Date: Tue, 7 May 2024 11:42:05 -0400 Subject: [PATCH 1/4] clarify checklist in PR template --- .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 56bee3d2d2..cf2f7f1e0f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,7 +8,7 @@ Closes # This PR addresses ... -**Checklist for maintainers** +**Checklist for PR authors** - [ ] added entry in `CHANGES.rst` within the relevant release section - [ ] updated or added relevant tests - [ ] updated relevant documentation From e34cb9796071149242d754efa7a08ed8bea1775d Mon Sep 17 00:00:00 2001 From: Brett Date: Tue, 7 May 2024 11:53:38 -0400 Subject: [PATCH 2/4] add item to checklist about resolving comments --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cf2f7f1e0f..e5b1c56ff0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,3 +17,4 @@ This PR addresses ... - [ ] ran regression tests, post a link to the Jenkins job below. [How to run regression tests on a PR](https://github.com/spacetelescope/jwst/wiki/Running-Regression-Tests-Against-PR-Branches) - [ ] Make sure the JIRA ticket is [resolved properly](https://github.com/spacetelescope/jwst/wiki/How-to-resolve-JIRA-issues) +- [ ] All comments are resolved From de319ef7a8b68a208df9258140dafa302b2b48a2 Mon Sep 17 00:00:00 2001 From: Brett Date: Tue, 7 May 2024 18:49:46 -0400 Subject: [PATCH 3/4] reorder checklist add note about irrelevant items --- .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 e5b1c56ff0..8cfc898925 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,6 +9,8 @@ Closes # This PR addresses ... **Checklist for PR authors** +Please check off the items in this list as they are completed. Please +skip or [strikethrough](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#styling-text) any irrelevant items. - [ ] added entry in `CHANGES.rst` within the relevant release section - [ ] updated or added relevant tests - [ ] updated relevant documentation @@ -16,5 +18,5 @@ This PR addresses ... - [ ] added relevant label(s) - [ ] ran regression tests, post a link to the Jenkins job below. [How to run regression tests on a PR](https://github.com/spacetelescope/jwst/wiki/Running-Regression-Tests-Against-PR-Branches) -- [ ] Make sure the JIRA ticket is [resolved properly](https://github.com/spacetelescope/jwst/wiki/How-to-resolve-JIRA-issues) - [ ] All comments are resolved +- [ ] Make sure the JIRA ticket is [resolved properly](https://github.com/spacetelescope/jwst/wiki/How-to-resolve-JIRA-issues) From 2fe1df614f2e5b6e64d72ee7d2bea29f935c0b0f Mon Sep 17 00:00:00 2001 From: Brett Date: Wed, 8 May 2024 11:59:44 -0400 Subject: [PATCH 4/4] add note about permissions --- .github/pull_request_template.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8cfc898925..39941f867a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,9 +8,7 @@ Closes # This PR addresses ... -**Checklist for PR authors** -Please check off the items in this list as they are completed. Please -skip or [strikethrough](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#styling-text) any irrelevant items. +**Checklist for PR authors (skip items if you don't have permissions or they are not applicable)** - [ ] added entry in `CHANGES.rst` within the relevant release section - [ ] updated or added relevant tests - [ ] updated relevant documentation