Contributing

This document guides how to contribute to this repository.

Check the CI configuration file

Even when there is no document about contributing to a repository, a good way to start is to check the repository's CI configuration file where how to build and test are written. In this repository, it is .github/workflows/build.yml.

Run workflow

This repository uses Docksotre Command Line Interface (CLI) to run the workflow. Install it on your local. See ci/install-dockstore-cli.sh. Then to run the workflow, run the command below.

$ make run

Run test

To verify the workflow files (*.wdl files), you can run the tests. First you need to install dependency packages.

on Debian-based Linux

$ sudo apt install python3-pytest python3-pytest-xdist

on Fedora Linux,

$ sudo dnf install python3-pytest python3-pytest-xdist

If you don't have the root permission, you can install the PyPI packages.

$ pip3 install --user pytest pytest-xdist

Then run the test.

$ make test