From c05227a388fd996016dafb5c1367c1136f4d4a26 Mon Sep 17 00:00:00 2001 From: Tobias Buck Date: Thu, 12 Feb 2026 11:51:46 +0100 Subject: [PATCH 1/2] Add contributors section and update README with All Contributors badge --- .all-contributorsrc | 4 ++++ README.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..56f0387 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,4 @@ +{ + "projectName": "CODES-Benchmark", + "projectOwner": "AstroAI-Lab" +} \ No newline at end of file diff --git a/README.md b/README.md index 18a785b..45a50c0 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![codecov](https://codecov.io/github/robin-janssen/CODES-Benchmark/branch/main/graph/badge.svg?token=TNF9ISCAJK)](https://codecov.io/github/robin-janssen/CODES-Benchmark) ![Static Badge](https://img.shields.io/badge/license-GPLv3-blue) ![Static Badge](https://img.shields.io/badge/NeurIPS-2024-green) +[![All Contributors](https://img.shields.io/github/all-contributors/AstroAI-Lab/CODES-Benchmark?color=ee8449&style=flat-square)](#contributors) 🎉 CODES was accepted to the ML4PS workshop @ NeurIPS2024 🎉 @@ -174,3 +175,15 @@ pip install -r requirements.txt The installation is now complete. To be able to run and evaluate the benchmark, you need to first set up a configuration YAML file. There is one provided, but it should be configured. For more information, check the [configuration page](https://robin-janssen.github.io/CODES-Benchmark/documentation.html#config). There, we also offer an interactive Config-Generator tool with some explanations to help you set up your benchmark. You can also add your own datasets and models to the benchmark to evaluate them against each other or some of our baseline models. For more information on how to do this, please refer to the [documentation](https://robin-janssen.github.io/CODES-Benchmark/documentation.html). + + +## Contributors + + + + + + + + + \ No newline at end of file From 64b8d361c44c75ae565333625b1cef543edef396 Mon Sep 17 00:00:00 2001 From: Robin Date: Fri, 13 Feb 2026 14:33:16 +0100 Subject: [PATCH 2/2] Add contributing.md and update readme accordingly --- CONTRIBUTING.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 +---- 2 files changed, 99 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4323849 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,97 @@ +# Contributing to CODES Benchmark + +Thanks for helping improve CODES Benchmark. Contributions of all sizes are welcome, including bug fixes, new features, documentation updates, and benchmark extensions. + +## What to contribute + +Common contribution types in this repository are: + +- Adding a new dataset +- Adding a new surrogate model +- Adding or improving benchmark evaluations and modalities + +For extension-specific implementation details, follow the dedicated guide: + +- https://astroai-lab.de/CODES-Benchmark/guides/extending-benchmark.html + +## Development setup + +Use either `uv` (recommended) or a standard `venv` + `pip` setup. + +### Option A: uv (recommended) + +```bash +git clone https://github.com/robin-janssen/CODES-Benchmark.git +cd CODES-Benchmark +uv sync +source .venv/bin/activate +uv pip install --group dev +``` + +### Option B: venv + pip + +```bash +git clone https://github.com/robin-janssen/CODES-Benchmark.git +cd CODES-Benchmark +python -m venv .venv +source .venv/bin/activate +pip install -e . +pip install -r requirements.txt +pip install black isort pytest sphinx +``` + +## Code style and formatting + +This repository uses: + +- [Black](https://black.readthedocs.io/en/stable/) for formatting +- [isort](https://pycqa.github.io/isort/) for import sorting + +The CI pipeline auto-applies both tools on contributions. Running them locally is still recommended so you get fast feedback before opening or updating a pull request. + +Run both locally with: + +```bash +black . +isort . +``` + +If you use pre-commit, install hooks once and run them across the repository: + +```bash +pre-commit install +pre-commit run --all-files +``` + +## Tests and documentation checks + +Before submitting a PR, run: + +```bash +pytest +sphinx-build -b html docs/source docs/_build/html +``` + +If your change affects user-facing behavior, update the relevant docs in `docs/source/`. + +## Standard contribution workflow + +1. Create an issue (bug report, feature request, or extension proposal), or choose an open issue to work on. +2. Create a branch from `main` with a clear name. +3. Implement your changes and include tests/docs updates where relevant. +4. Run formatting, tests, and docs build locally. +5. Open a pull request and link the issue. +6. Address review feedback and keep your branch up to date. + +## Pull request expectations + +Please keep PRs focused and easy to review. + +- Explain what changed and why. +- Link related issues. +- Include tests for behavior changes. +- Include documentation updates for new datasets, surrogates, modalities, or config options. + +## Need help? + +If you are unsure where to start, open an issue with your proposal or question. diff --git a/README.md b/README.md index 2330711..c0eaf9a 100644 --- a/README.md +++ b/README.md @@ -64,15 +64,9 @@ The GitHub Pages site now hosts the narrative guides, configuration reference, a ## Contributing -Pull requests are welcome! Please include documentation updates, add or update tests when you touch executable code, and run: +Contribution guidelines are documented in [CONTRIBUTING.md](CONTRIBUTING.md). -```bash -uv pip install --group dev -pytest -sphinx-build -b html docs/source/ docs/_build/html -``` - -If you publish a new surrogate or dataset, document it under `docs/guides` / `docs/reference` so users can adopt it quickly. For questions, open an issue on GitHub. +In short: open or pick an issue, make your changes in a branch, and submit a pull request with tests/docs updates as needed. ## Contributors