Skip to content

Commit

Permalink
Add note about system tests in contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
MakisH committed Mar 13, 2024
1 parent 0e91542 commit 1a1db0c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,13 @@ There are also a few additional workflows that can be triggered manually:
- `Check links`: checks the links in all markdown files to verify if they are still reachable.

Members of the repository can trigger these workflows in the "Actions" tab.

## System tests

For non-trivial pull requests, we also need to execute [system regression tests](https://precice.org/dev-docs-system-tests.html),
to ensure that complete simulations still run and give the same results.
Because these take long, run on an external system, and consume significant resources,
we are only triggering these on demand. Add (or ask a maintainer to add) the
`trigger-system-tests` label to the pull request to trigger them.
The tests will only run once, so that further commits don't consume additional
resources: In case you want to re-trigger them, remove and add the label again.

0 comments on commit 1a1db0c

Please sign in to comment.