Skip to content
Snippets Groups Projects
Commit 5b9de40e authored by Workum, Dirk-Jan van's avatar Workum, Dirk-Jan van
Browse files

add information about local setup for development to contributing

parent a87c58c2
No related branches found
No related tags found
2 merge requests!251Create release v4.3.2,!231Update CONTRIBUTING.md to reflect current situation
Pipeline #93950 passed
......@@ -125,7 +125,15 @@ GitLab has a [nice introduction][gitlab-flow] to the merge request workflow, but
## Local development
You can build and run _PanTools_ locally. Please refer to the [manual][pantools-manual] for instructions on how to build, and run _PanTools_.
You can build and run _PanTools_ locally.
Please refer to the [manual][pantools-manual] for instructions on how to setup, build, and run _PanTools_.
This is a short-list of important parts of our setup:
- We use [pre-commit](https://pre-commit.com/) to run checks before committing.
- We use [IntelliJ IDEA](https://www.jetbrains.com/idea/) as our IDE.
- We use [Maven](https://maven.apache.org/) as our build tool.
- We use [log4j2](https://logging.apache.org/log4j/2.x/) for logging.
- We use [ReadTheDocs](https://readthedocs.org/) for our documentation.
- We use [Snakemake](https://snakemake.readthedocs.io/) for our end-to-end tests in the CI/CD pipeline.
## Git organization
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment