Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 1.96 KB

Contributing guidelines

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!

Submitting issues

Before submitting an issue, please verify there is not a similar one already listed.

Development

Instructions on how to contribute code to this repository in the best way possible.

Development environment

How to set up your development environment. For ease of use, consider using

Recommended tools

Installing required packages

To install python packages using your system interpreter:

make setup

Docker image

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.

Unit tests

To run unit tests:

make test

Integration tests

To run the integration tests:

make validate

Commit messages

For git commit messages, please follow the Conventional Commits specification.

Submitting changes

Please send us a GitHub Pull Request with a clear description.

Good luck and thank you! 🙇🏻‍♂️ ❤️