From cfef4175bf910965a309b728348068e5eed3f715 Mon Sep 17 00:00:00 2001 From: "Pey Lian Lim (Github)" <2090236+pllim@users.noreply.github.com> Date: Wed, 14 Sep 2022 11:20:51 -0400 Subject: [PATCH 1/2] DEV: Clarify change log policy --- .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 8f03e46969..ab66e57a0d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -32,6 +32,6 @@ This checklist is meant to remind the package maintainer(s) who will review this - [ ] Are tests added/updated as required? If so, do they follow the [STScI Style Guides](https://github.com/spacetelescope/style-guides)? - [ ] Are docs added/updated as required? If so, do they follow the [STScI Style Guides](https://github.com/spacetelescope/style-guides)? - [ ] Did the CI pass? If not, are the failures related? -- [ ] Is a change log needed? If yes, is it added to `CHANGES.rst`? +- [ ] Is a change log needed? If yes, is it added to `CHANGES.rst`? If you want to avoid conflict, you can wait till PR is close to merge before adding it. - [ ] Is a milestone set? - [ ] After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? From fbb98ef88aed225d252adbc82c3e3553897424ac Mon Sep 17 00:00:00 2001 From: Kyle Conroy Date: Thu, 15 Sep 2022 09:31:25 -0400 Subject: [PATCH 2/2] separate section in PR template for change log entry that gives a space for devs to include the change log entry in the PR description if waiting to add it to changes.rst. --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ab66e57a0d..0a8bc18b5f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,6 +20,11 @@ the following line. --> Fixes # +### Change log entry + +- [ ] Is a change log needed? If yes, is it added to `CHANGES.rst`? If you want to avoid merge conflicts, + list the proposed change log here for review and add to `CHANGES.rst` before merge. + ### Checklist for package maintainer(s) @@ -32,6 +37,5 @@ This checklist is meant to remind the package maintainer(s) who will review this - [ ] Are tests added/updated as required? If so, do they follow the [STScI Style Guides](https://github.com/spacetelescope/style-guides)? - [ ] Are docs added/updated as required? If so, do they follow the [STScI Style Guides](https://github.com/spacetelescope/style-guides)? - [ ] Did the CI pass? If not, are the failures related? -- [ ] Is a change log needed? If yes, is it added to `CHANGES.rst`? If you want to avoid conflict, you can wait till PR is close to merge before adding it. - [ ] Is a milestone set? - [ ] After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?