Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pull request template #423

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Pull request template #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae6da89
Template for pull requests.
mellis13 Nov 18, 2023
e57eee8
Add changelog content
mellis13 Nov 18, 2023
2f3cb9f
Small text edits.
mellis13 Nov 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion doc/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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_)
Expand All @@ -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
Expand Down