Contains recipes for building Docker images for bioinformatics tools. The main focus is on scripts/tools built within the Zavolan lab, but third-party tools are also included, if no well-maintained official image repository exists (or has existed at the time of creation) for these tools.
The corresponding images can be found on the lab's Docker Hub space.
Your contributions are highly appreciated!
To add a Dockerfile for a new tool or a different version of an existing tool, please follow these simple rules:
- If you are already a member of the
zavolanlaborganization here on GitHub, please clone the repository and create a feature branch off of branchmaster(see Git Flow for details on why/how to do that). If you are an external contributor, please fork the repository instead. - Please create a new directory with the tool's name and/or version. It is
important that you stick to the directory structure/naming conventions:
<root_dir>/<tool_name>/<version>/Dockerfile. If you are unsure, have a look at some of the existing examples. - In order to reduce image size and possible security risks, try to only add software that is required to run the tool and follow best practices for writing Dockerfiles. Do not forget to include relevant metadata as well (have a look at the existing examples).
- Document your code and update all relevant documentation, if necessary. Add your name and GitHub profile URL to the list of contributors.
- Issue a pull request (PR). Upon filing, images are automatically built for
all new and modified Dockerfiles within the scope of the PR. PRs are not
merged into the main branch (
master) unless this check passes and at least one member of the Zavolan lab approves of the PR. Once merged, images are automatically pushed to the lab's Docker Hub space.
For more information (particularly if you have are new to Git/GitHub) or other ways of how you can contribute, please take a look at the contributor instructions.
This project is covered by the Apache License 2.0 also shipped with this repository.
