How to contribute?
Hi there!
RiverBench is an open, community-driven project, so you are more than welcome to contribute. This page explains how to do it.
Reporting benchmark results
If you have run a benchmark using RiverBench's datasets or tasks, we highly encourage you to share your results. After filling out a simple form, your benchmark run will be listed on the RiverBench website (along with proper citation, of course) in a machine- and human-readable format. See our dedicated brief guide on reporting benchmark results for more details.
Contributing datasets
Do you have an interesting RDF dataset that would make a good addition to RiverBench? Great!
Have a look at the dedicated guide on creating new datasets which also explains the requirements for new datasets. If you still have questions, don't hesitate to contact RiverBench's maintainers by opening an issue on GitHub.
Contributing benchmark tasks
Do you want to share your benchmarking procedure with the world? Publishing it in RiverBench will give your task a permanent URI and make it easy to reference in papers and other publications. Others will also have the chance to contribute their results and notes about conducting the benchmark.
Reporting issues
Found a bug in a dataset or the metadata? Or in something else entirely? Feel free to open an issue on GitHub. Please try to be as specific as possible on your issue, so that it can be resolved quickly.
Improving the documentation
You can easily edit the documentation on this website – see the dedicated guide for more details.
Improving the code or metadata
Have a look at our GitHub organization page and the repositories there. Some important ones are:
- RiverBench – the main repository
- riverbench.github.io – the repository for the website
- schema – schemas and ontologies
- ci-worker – source for the application that packages datasets, munges metadata, and generates documentation (Scala)
- ci-workflows – GitHub Actions workflows for the CI
- dataset-template – template repository for new datasets
You are welcome to submit any pull requests to these repositories. If you are unsure where to submit your changes, feel free to open an issue and ask.
Deeper changes
Do you see a glaring issue with the way RiverBench is organized? Or maybe you have a great idea for a new feature? You can either open an issue or contact the maintainers directly: RiverBench maintainers.