We are really glad you are seeing this and are considering contributing to the development of this tool. We welcome any pull requests that help us grow as open source software!
Before submitting an issue, please verify there is not a similar one already listed.
Instructions on how to contribute code to this repository in the best way possible.
How to set up your development environment. For ease of use, consider using
- UNIX-based operating system
- Python Interpreter v3.11
- Pip
- Pycharm IDE
- Docker engine v24.0.0
- Docker compose v2.20
- Blaze store as a docker container
- BlazeCTL: a command line tool for interacting with a Blaze store
- FHIR Test data generator: a command line tool for generating FHIR test data according to the BBMRI.de FHIR profile.
To install python packages using your system interpreter:
make setup
Docker images are built continuously as part of the CI pipeline. However, for building your own test images simply
run: docker build . -t ghcr.io/bbmri-cz/fhir-module:local
in the directory containing the Dockerfile
.
To run unit tests:
make test
To run the integration tests:
make validate
For git commit messages, please follow the Conventional Commits specification.
Please send us a GitHub Pull Request with a clear description.
Good luck and thank you! 🙇🏻♂️ ❤️