Hi there! Amazing that you want to contribute to this project! Please have a look at the page contributing to preCICE and watch out for more specific details in this file.
Instead of directly editing CHANGELOG.md, please add a file 123.md
in changelog-entries, where 123 your pull request number. This helps reduce
merge conflicts and we will merge these files at the time we release a new version.
We use pre-commit to ensure consistent formatting.
Please install pre-commit and then install the hook in this repository with pre-commit install.
This ensures correct formatting for future commits.
Run pre-commit run -va to apply formatting retrospectively.
We check every contribution with a few GitHub Actions workflows that report at the bottom of each pull request.
There are also a few additional workflows that can be triggered manually:
Custom build: builds any branch of the repository with any of the available OpenFOAM versions.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.
For non-trivial pull requests, we also need to execute system regression tests,
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.