Skip to content

[WIP] Add cwltool specific contributing guide #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 27, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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