Skip to content

Commit dd13278

Browse files
manu-chromatetron
authored andcommitted
CONTRIBUTING.md: Add instructions for setting up dev env (#508)
1 parent 88fd6f5 commit dd13278

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
In order to contribute to the development of ``cwltool``, you need to install cwltool from source (preferably in a virtual environment):
2+
Here's a rough
3+
- Install virtualenv via pip: ``pip install virtualenv``
4+
- Clone the cwltool: ``git clone https://github.com/common-workflow-language/cwltool.git``
5+
- Switch to cwltool directory: ``cd cwltool``
6+
- Create a virtual environment: ``virtualenv cwltool``
7+
- To begin using the virtual environment, it needs to be activated: ``source bin/activate``
8+
- To check if you have the virtual environment set up: ``which python`` and it should point to python executable in your virtual env
9+
- Install cwltool in the virtual environment: ``pip install .``
10+
- Check the version which might be different from the version installed in general on any system: ``cwltool --version``
11+
- After you've made the changes, you can the complete test suite via tox: ``tox``
12+
- If you want to run specific tests, say ``unit tests`` in Python 3.5, then: ``tox -e py35-unit``.
13+
- Look at ``tox.ini`` for all available tests and runtimes
14+
- If tests are passing, you can simply commit and create a PR on ``cwltool`` repo:
15+
- After you're done working on the ``cwltool``, you can deactivate the virtual environment: ``deactivate``

0 commit comments

Comments
 (0)