From ae6da892f52c40999c75acba96dc7e2cdbcfcc11 Mon Sep 17 00:00:00 2001 From: Matthew Ellis Date: Sat, 18 Nov 2023 21:59:25 +0800 Subject: [PATCH 1/3] Template for pull requests. --- .github/pull_request_template.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..d64beee45 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +# 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: + + - [ ] Code review for style, design, and accuracy + - [ ] Unit test review for completeness and accuracy + - [ ] Verification of Github CI/CD actions passing + - [ ] Verification of external WLM tests passing + - [ ] Review of documentation for proper content, build, and rendering + - [ ] Review of 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 From e57eee88d525521bbdd32b75a1f31ee3f098d494 Mon Sep 17 00:00:00 2001 From: Matthew Ellis Date: Sun, 19 Nov 2023 07:38:33 +0800 Subject: [PATCH 2/3] Add changelog content --- .github/pull_request_template.md | 9 +++++---- doc/changelog.rst | 4 +++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d64beee45..7205c9ecf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,9 +9,10 @@ The following pull request review steps must be completed before merging: - [ ] Code review for style, design, and accuracy - [ ] Unit test review for completeness and accuracy - - [ ] Verification of Github CI/CD actions passing - - [ ] Verification of external WLM tests passing - - [ ] Review of documentation for proper content, build, and rendering - - [ ] Review of examples for sufficient breadth 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 4e17aaaf7..203cdc640 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 From 2f3cb9ff50a8d93ffe9cfeb20c446cfff93012ba Mon Sep 17 00:00:00 2001 From: Matthew Ellis Date: Sun, 19 Nov 2023 07:39:40 +0800 Subject: [PATCH 3/3] Small text edits. --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7205c9ecf..6339837bd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,8 +7,8 @@ A clear and concise description of the implementation strategy. # Pull Request Acceptance Criteria The following pull request review steps must be completed before merging: - - [ ] Code review for style, design, and accuracy - - [ ] Unit test review for completeness and accuracy + - [ ] 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