From ff70e5d4b4036e77dc2c307a8c0df44f66e8f8fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20Cavignac?= Date: Wed, 1 Jul 2026 15:19:17 +0200 Subject: [PATCH 1/2] doc: document testing setup in CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 841116ce5..470ab0a73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,3 +11,26 @@ Simply add a comment under an issue if you are interested in tackling it! Recommendations for setting up a development environment for this package can be found in the [Installation instructions](https://www.optimade.org/optimade-python-tools/INSTALL/#full-development-installation). More broadly, if you would like to ask questions or contact the consortium about creating an OPTIMADE implementation for a new database, then please read the relevant "get involved" section on the [OPTIMADE website](https://www.optimade.org/#get-involved). + +## Setup a testing environment + +Make sure you have submodules checked out after cloning: +```bash +git submodule update --init --recursive +``` + +Setup the python environment: +```bash +uv sync -p 3.12 --all-groups --all-extra +source .venv/bin/activate +``` + +Initialize aiida: +```bash +verdi presto +``` + +Run the test suite: +```bash +pytest +``` From cdbdd7ef473a389a5f34c266932a2e7d8158a24b Mon Sep 17 00:00:00 2001 From: Matthew Evans Date: Thu, 2 Jul 2026 17:00:42 +0200 Subject: [PATCH 2/2] Fix link to installation docs and remove additional info added to contributing Co-authored-by: Matthew Evans --- CONTRIBUTING.md | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 470ab0a73..0618b17a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,29 +8,6 @@ This may be anything from simple feedback and raising [new issues](https://githu If you are interested in contributing but don't know where to begin, some issues have been marked with the [good first issue](https://github.com/Materials-Consortia/optimade-python-tools/labels/good%20first%20issue) label, typically where an isolated enhancement has a concrete suggestion. Simply add a comment under an issue if you are interested in tackling it! -Recommendations for setting up a development environment for this package can be found in the [Installation instructions](https://www.optimade.org/optimade-python-tools/INSTALL/#full-development-installation). +Recommendations for setting up a development environment for this package can be found in the [Installation instructions](https://www.optimade.org/optimade-python-tools/latest/INSTALL/#full-development-installation). More broadly, if you would like to ask questions or contact the consortium about creating an OPTIMADE implementation for a new database, then please read the relevant "get involved" section on the [OPTIMADE website](https://www.optimade.org/#get-involved). - -## Setup a testing environment - -Make sure you have submodules checked out after cloning: -```bash -git submodule update --init --recursive -``` - -Setup the python environment: -```bash -uv sync -p 3.12 --all-groups --all-extra -source .venv/bin/activate -``` - -Initialize aiida: -```bash -verdi presto -``` - -Run the test suite: -```bash -pytest -```