Skip to content

Commit 149830b

Browse files
authored
Update pull_request_template.md (#562)
1 parent 402a38e commit 149830b

File tree

1 file changed

+18
-30
lines changed

1 file changed

+18
-30
lines changed

pull_request_template.md

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,26 @@
11
## Description
22

3-
FIXME:Provide a short summary of the change. Please also include relevant
4-
motivation and context.
3+
- [ ] Replace with: A short description of the change, including motivation and context.
4+
- [ ] Replace with: A list of any dependencies.
5+
- [ ] Replace with: Link(s) to relevant [issue(s)](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
6+
- [ ] Complete the checklist for a relevant section(s) below
7+
- [ ] Delete sections below that are not relevant to this PR
58

6-
Dependencies: FIXME:Add a list of any dependencies.
9+
## Adding/modifying a system (docs: [Adding a System](https://software.llnl.gov/benchpark/add-a-system-config.html))
710

8-
Fixes issue(s): FIXME:Add list of relevant issues.
11+
- [ ] Add/modify `systems/system_name/Create a new directory for the system, add/modify `system.py` file
12+
- [ ] Add/modify a dry run unit test in `.github/workflows/run.yml`
13+
- [ ] Add/modify `systems/all_system_definitions/system-hardware/system_definition.yaml which will appear in the [docs catalogue](https://software.llnl.gov/benchpark/system-list.html)
914

10-
## Type of Change
15+
## Adding/modifying a benchmark (docs: [Adding a Benchmark](https://software.llnl.gov/benchpark/add-a-benchmark.html))
1116

12-
- { } Adding a system, benchmark, or experiment
13-
- { } Modifying an existing system, benchmark, or experiment
14-
- { } Documentation update
15-
- { } Build/CI update
16-
- { } Benchpark core functionality
17+
- [ ] (optional) If package upstreamed to Spack is insufficient, add/modify `repo/benchmark_name/package.py`
18+
- [ ] (optional) If application upstreamed to Ramble is insufficient, add/modify `repo/benchmark_name/application.py`
19+
- [ ] Tags in Ramble's `application.py` or in `repo/benchmark_name/application.py` will appear in the [docs catalogue](https://software.llnl.gov/benchpark/benchmark-list.html)
20+
- [ ] Add/modify an `experiments/benchmark_name/experiment.py` to define a single node and multi-node experiments
21+
- [ ] Add/modify a dry run unit test in `.github/workflows/run.yml`
1722

18-
## Checklist:
23+
## Adding/modifying core functionality, CI, or documentation:
1924

20-
If adding/modifying a system:
21-
- { } Create a new directory for the system and a new `system.py` file
22-
- { } Add a new dry run unit test in `.github/workflows`
23-
- { } System appears in System Specifications table in docs catalogue section
24-
25-
If adding/modifying a benchpark:
26-
- { } Add a new `application.py` and (maybe) `package.py` under a new directory
27-
for this benchmark
28-
- { } Configure an experiment
29-
- { } Benchmark appears in Benchmarks and Experiments table in docs catalogue
30-
section
31-
32-
If adding/modifying a experiment:
33-
- { } Extend `experiment.py` under existing directory for specific benchmark
34-
- { } Define a single node and multi-node experiments
35-
36-
If adding/modifying core functionality:
37-
- { } Update docs
38-
- { } Update `.github/workflows` and `.gitlab/ci` unit tests (if needed)
25+
- [ ] Update docs
26+
- [ ] Update `.github/workflows` and `.gitlab/ci` unit tests (if needed)

0 commit comments

Comments
 (0)