Skip to content

Commit f96130d

Browse files
Add change checklist to PR template, including item to post change announcement per (NREL#106
1 parent d36ce78 commit f96130d

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

.github/pull_request_template.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,21 @@ and any other relevant information.
1111

1212
---
1313

14-
*Additional metadata such as TODO items or link to self-reviews (PR into your own fork created prior to submission)*
14+
**Change Checklist**:
15+
16+
Before merging:
17+
1. [ ] Add a CHANGELOG entry ([example](https://github.com/NREL/GEOPHIRES-X/commit/15e10e5c3c08633a16645e41dfb7e8131805483f)). RST Template:
18+
```restructuredtext
19+
M.m.P: `TITLE <https://github.com/NREL/GEOPHIRES-X/pull/PR-NUMBER>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/vM.m.P>`__
20+
```
21+
22+
After merging:
23+
1. [ ] Push tag(s) to GitHub: `git push origin refs/tags/vM.m.P`
24+
1. [ ] Post a change announcement to the [GEOPHIRES Change Announcements Discussion](https://github.com/NREL/GEOPHIRES-X/discussions/428) ([example](https://github.com/NREL/GEOPHIRES-X/discussions/428#discussioncomment-14593405)). Markdown template:
25+
```markdown
26+
M.m.p: [TITLE](https://github.com/NREL/GEOPHIRES-X/pull/PR-NUMBER) | [release](https://github.com/NREL/GEOPHIRES-X/releases/tag/vM.m.P)`
27+
```
28+
29+
---
30+
31+
*Additional metadata such as TODO items or link to your initial self-review (PR into your own fork created prior to submission)*

0 commit comments

Comments
 (0)