diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..6339837bda --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +# Description +A clear and concise description of what the feature or bug fix is intended to do. + +# Implementation Strategy +A clear and concise description of the implementation strategy. + +# Pull Request Acceptance Criteria +The following pull request review steps must be completed before merging: + + - [ ] Review code for style, design, and accuracy + - [ ] Review unit tests for completeness and accuracy + - [ ] Verify ``changelog.rst`` entry + - [ ] Verify Github CI/CD actions passing + - [ ] Verify external WLM tests passing + - [ ] Review documentation for proper content, build, and rendering + - [ ] Review and run examples for sufficient breadth and accuracy + - [ ] Independent developer feature stress test + - [ ] 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 \ No newline at end of file diff --git a/doc/changelog.rst b/doc/changelog.rst index 4e17aaaf71..203cdc6404 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -19,6 +19,7 @@ To be released at some future point in time Description +- Add template for pull requests - Split tests into groups for parallel execution in CI/CD pipeline - Change signature of `Experiment.summary()` - Expose first_device parameter for scripts, functions, models @@ -28,6 +29,7 @@ Description Detailed Notes +- Add a template for Github pull requests (PR423_) - Split tests into `group_a`, `group_b`, `slow_tests` for parallel execution in CI/CD pipeline (PR417_) - Change `format` argument to `style` in `Experiment.summary()`, this is an API break (PR391_) @@ -44,7 +46,7 @@ Detailed Notes bug has been fixed. This applies to all operating systems. (PR383_) - Add support for creation of multiple databases with unique identifiers. (PR342_) - + .. _PR423: https://github.com/CrayLabs/SmartSim/pull/423 .. _PR417: https://github.com/CrayLabs/SmartSim/pull/417 .. _PR391: https://github.com/CrayLabs/SmartSim/pull/391 .. _PR342: https://github.com/CrayLabs/SmartSim/pull/342