From 35bc3239714ede61f2b3394accbd235b798c8c7d Mon Sep 17 00:00:00 2001 From: pearce8 Date: Thu, 23 Jan 2025 01:06:59 -0800 Subject: [PATCH] Update pull_request_template.md --- pull_request_template.md | 48 +++++++++++++++------------------------- 1 file changed, 18 insertions(+), 30 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 4391a6617..d9e0891c8 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,38 +1,26 @@ ## Description -FIXME:Provide a short summary of the change. Please also include relevant -motivation and context. +- [ ] Replace with: A short description of the change, including motivation and context. +- [ ] Replace with: A list of any dependencies. +- [ ] 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) +- [ ] Complete the checklist for a relevant section(s) below +- [ ] Delete sections below that are not relevant to this PR -Dependencies: FIXME:Add a list of any dependencies. +## Adding/modifying a system (docs: [Adding a System](https://software.llnl.gov/benchpark/add-a-system-config.html)) -Fixes issue(s): FIXME:Add list of relevant issues. +- [ ] Add/modify `systems/system_name/Create a new directory for the system, add/modify `system.py` file +- [ ] Add/modify a dry run unit test in `.github/workflows/run.yml` +- [ ] 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) -## Type of Change +## Adding/modifying a benchmark (docs: [Adding a Benchmark](https://software.llnl.gov/benchpark/add-a-benchmark.html)) -- { } Adding a system, benchmark, or experiment -- { } Modifying an existing system, benchmark, or experiment -- { } Documentation update -- { } Build/CI update -- { } Benchpark core functionality +- [ ] (optional) If package upstreamed to Spack is insufficient, add/modify `repo/benchmark_name/package.py` +- [ ] (optional) If application upstreamed to Ramble is insufficient, add/modify `repo/benchmark_name/application.py` +- [ ] 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) +- [ ] Add/modify an `experiments/benchmark_name/experiment.py` to define a single node and multi-node experiments +- [ ] Add/modify a dry run unit test in `.github/workflows/run.yml` -## Checklist: +## Adding/modifying core functionality, CI, or documentation: -If adding/modifying a system: -- { } Create a new directory for the system and a new `system.py` file -- { } Add a new dry run unit test in `.github/workflows` -- { } System appears in System Specifications table in docs catalogue section - -If adding/modifying a benchpark: -- { } Add a new `application.py` and (maybe) `package.py` under a new directory - for this benchmark -- { } Configure an experiment -- { } Benchmark appears in Benchmarks and Experiments table in docs catalogue - section - -If adding/modifying a experiment: -- { } Extend `experiment.py` under existing directory for specific benchmark -- { } Define a single node and multi-node experiments - -If adding/modifying core functionality: -- { } Update docs -- { } Update `.github/workflows` and `.gitlab/ci` unit tests (if needed) +- [ ] Update docs +- [ ] Update `.github/workflows` and `.gitlab/ci` unit tests (if needed)