Skip to content

Commit da94478

Browse files
committed
Add a CONTRIBUTING guide
1 parent 82c9c65 commit da94478

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Style guide:
2+
- PEP-8 / format with ``black`` via ``make format``
3+
- Python 3.6+ compatible code
4+
- PEP-484 type hints
5+
6+
In order to contribute to the development of ``cwl-utils``, you need to install cwl-utils from source (preferably in a virtual environment):
7+
Here's a rough guide (improvements are welcome!)
8+
- Install virtualenv via pip: ``pip install virtualenv``
9+
- Clone the cwl-utils Git repository: ``git clone https://github.com/common-workflow-language/cwl-utils.git``
10+
- Switch to cwl-utils directory: ``cd cwl-utils``
11+
- Create a virtual environment: ``virtualenv env``
12+
- To begin using the virtual environment, it needs to be activated: ``source env/bin/activate``
13+
- To check if you have the virtual environment set up: ``which python`` and it should point to python executable in your virtual env
14+
- Install cwl-utils in the virtual environment: ``pip install -e .``
15+
- Check the version which might be different from the version installed in general on any system: ``pip show cwl-utils``
16+
- After you've made the changes, you can the complete test suite via tox: ``tox``
17+
- If you want to run specific tests, say ``unit tests`` in Python 3.8, then: ``tox -e py38-unit``.
18+
- Look at ``tox.ini`` for all available tests and runtimes
19+
- If tests are passing, you can create a PR on ``cwl-utils`` GitHub repository.
20+
- After you're done working on the ``cwl-utils``, you can deactivate the virtual environment: ``deactivate``

0 commit comments

Comments
 (0)