Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.79 KB

pull_request_template.md

File metadata and controls

26 lines (19 loc) · 1.79 KB

Description

  • 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)
  • Complete the checklist for a relevant section(s) below
  • Delete sections below that are not relevant to this PR

Adding/modifying a system (docs: Adding a System)

  • 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

Adding/modifying a benchmark (docs: Adding a Benchmark)

  • (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
  • 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

Adding/modifying core functionality, CI, or documentation:

  • Update docs
  • Update .github/workflows and .gitlab/ci unit tests (if needed)