Skip to content
59 changes: 59 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/add_software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Pull Request Template for adding software – EESSI Software Layer

## Description
<!-- Give some context for the changes introduced by this PR -->
- What is the software being added?
- What domain does it serve?
- Why are you adding it?
- ...

## Target File(s)
<!-- Confirm that this PR modifies the correct file(s) -->

For new software, the typical path format is:

- `easystacks/software.eessi.io/<EESSI version>/eessi-<EESSI version>-eb-<EasyBuild version>-<toolchain>.yml`

Example:

- `easystacks/software.eessi.io/2025.06/eessi-2025.06-eb-5.3.0-2025a.yml`

Please verify:

- [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [ ] I am using the **latest EasyBuild version** (e.g. `5.3.0`)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [ ] I selected the **correct toolchain family** (e.g. `2025a`)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

family -> generation ?

- [ ] I did **not** modify older or unrelated files
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

older or other?


### Toolchain Notes

- The toolchain suffix (e.g. `2025a`) defines the compiler/MPI stack.
- See documentation: https://docs.easybuild.io/common-toolchains/

Sometimes it can be difficult to figure out which suffix your software belongs to, if in doubt please ask for help on
the [EESSI slack](https://join.slack.com/t/eessi-hpc/shared_invite/zt-2wg10p26d-m_CnRB89xQq3zk9qxf1k3g)

## Type of Change
<!-- Mark relevant options -->
- [ ] New software addition
- [ ] Version update
- [ ] Other (please specify):

## Testing
<!-- Describe how you validated your changes -->
- [ ] I have tested this PR locally using **EESSI-extend**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add link to docs

<!-- Hint:

module load EESSI/<EESSI version>
module load EESSI-extend

# Show what will be built
eb --missing --easystack <path to easystack>

# Perform the build
eb --robot --easystack <path to easystack>
-->
- [ ] The build completed successfully
- [ ] The installed software/module loads correctly
- [ ] Basic functionality has been verified
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

give example, like example --help ?

Copy link
Copy Markdown
Member Author

@ocaisa ocaisa Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to make this too big, what this might mean is very software specific so I don't have a problem with being a little vague (ideally the easyconfig is doing such basic checks anyway)


47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/rebuild_software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Pull Request Template for rebuilding software – EESSI Software Layer

## Description
<!-- Give some context for the changes introduced by this PR -->
- Why is the rebuild necessary?
- What are the potential positive/negative impacts?
- ...

## Target File(s)
<!-- Confirm that this PR modifies the correct file(s) -->

Rebuilds must be placed under the `rebuilds/` subdirectory:

- `easystacks/software.eessi.io/<EESSI version>/rebuilds/<date>-eb-<EasyBuild version>-<description>.yml`

Example:

- `easystacks/software.eessi.io/2025.06/rebuilds/20260413-eb-5.3.0-RStudio-r_home-patch.yml`

Please verify:

- [ ] This is a rebuild (not a standard addition/update)
- [ ] I am targeting the **correct EESSI version** (e.g. `2025.06` for toolchain families `2025a`, `2023.06` for toolchain families `2023b`)
- [ ] The file is placed in the correct `rebuilds/` directory
- [ ] I am using the **latest EasyBuild version** (e.g. `5.3.0`)
- [ ] The filename gives some indication of the reason for the rebuild
- [ ] The file includes comments explaining **exactly why the rebuild is necessary**
- [ ] I did **not** modify older or unrelated files

## Testing
<!-- Describe how you validated your changes -->
- [ ] I have tested this PR locally using **EESSI-extend**
<!-- Hint:

module load EESSI/<EESSI version>
module load EESSI-extend

# Show what will be rebuilt
eb --missing --rebuild --easystack <path to easystack>

# Perform the build (no dependencies are to be built, so no `--robot`)
eb --rebuild --easystack <path to easystack>
-->
- [ ] The build completed successfully
- [ ] The installed software/module loads correctly
- [ ] Basic functionality has been verified

1 change: 1 addition & 0 deletions .github/pull_request_template.md
Loading