From 1a1db0cc968b902a92d61d13669490e4e17aaf17 Mon Sep 17 00:00:00 2001 From: Gerasimos Chourdakis Date: Wed, 13 Mar 2024 13:08:41 +0100 Subject: [PATCH] Add note about system tests in contributing guidelines --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f48c65ce..b09fa65b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.