Skip to content

Commit e57eee8

Browse files
committed
Add changelog content
1 parent ae6da89 commit e57eee8

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

.github/pull_request_template.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ The following pull request review steps must be completed before merging:
99

1010
- [ ] Code review for style, design, and accuracy
1111
- [ ] Unit test review for completeness and accuracy
12-
- [ ] Verification of Github CI/CD actions passing
13-
- [ ] Verification of external WLM tests passing
14-
- [ ] Review of documentation for proper content, build, and rendering
15-
- [ ] Review of examples for sufficient breadth and accuracy
12+
- [ ] Verify ``changelog.rst`` entry
13+
- [ ] Verify Github CI/CD actions passing
14+
- [ ] Verify external WLM tests passing
15+
- [ ] Review documentation for proper content, build, and rendering
16+
- [ ] Review and run examples for sufficient breadth and accuracy
1617
- [ ] Independent developer feature stress test
1718
- [ ] Prior to closing the associated issue, verify documentation and examples have been properly uploaded to ``craylabs.org`` and all CI/CD tests pass post merge

doc/changelog.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ To be released at some future point in time
1919

2020
Description
2121

22+
- Add template for pull requests
2223
- Split tests into groups for parallel execution in CI/CD pipeline
2324
- Change signature of `Experiment.summary()`
2425
- Expose first_device parameter for scripts, functions, models
@@ -28,6 +29,7 @@ Description
2829

2930
Detailed Notes
3031

32+
- Add a template for Github pull requests (PR423_)
3133
- Split tests into `group_a`, `group_b`, `slow_tests` for parallel execution in CI/CD pipeline (PR417_)
3234
- Change `format` argument to `style` in `Experiment.summary()`, this is
3335
an API break (PR391_)
@@ -44,7 +46,7 @@ Detailed Notes
4446
bug has been fixed. This applies to all operating systems. (PR383_)
4547
- Add support for creation of multiple databases with unique identifiers. (PR342_)
4648

47-
49+
.. _PR423: https://github.com/CrayLabs/SmartSim/pull/423
4850
.. _PR417: https://github.com/CrayLabs/SmartSim/pull/417
4951
.. _PR391: https://github.com/CrayLabs/SmartSim/pull/391
5052
.. _PR342: https://github.com/CrayLabs/SmartSim/pull/342

0 commit comments

Comments
 (0)