Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
============
Contributing
============
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
----------------------
Report Bugs
~~~~~~~~~~~
Report bugs at https://github.com/galaxyproject/pulsar/issues.
If you are reporting a bug, please include:
* Your operating system name and version, versions of other relevant software
such as Galaxy or Docker.
* Links to relevant tools.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
Fix Bugs
~~~~~~~~
Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.
Implement Features
~~~~~~~~~~~~~~~~~~
Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
Pulsar is cronically under documented, whether as part of the
official Pulsar docs, in docstrings, or even on the web in blog posts,
articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://github.com/galaxyproject/planemo/issues.
If you are proposing a feature:
* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* This will hopefully become a community-driven project and contributions
are welcome :)
Get Started!
------------
Ready to contribute? Here's how to set up `pulsar` for local development.
1. Fork the `pulsar` repo on GitHub.
2. Clone your fork locally::
$ git clone git@github.com:your_name_here/pulsar.git
3. Install your local copy into a virtualenv. Assuming you have ``virtualenv`` installed, this is how you set up your fork for local development::
$ cd pulsar/
$ virtualenv .venv
$ . .venv/bin/activate
$ pip install -r requirements.txt
$ pip install -r dev-requirements.txt
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass ``flake8``
and ``pyflakes``::
$ pyflakes pulsar test && flake8 --exclude test_tool_deps.py --max-complexity 9 pulsar test
and ensure the tests look good. The easiest way to test is with Docker if it is
available (given the need to test commands with DRMAA, condor, sudo, etc...).::
$ docker run -v `pwd`:/pulsar -t jmchilton/pulsar_testing
This will mount your copy of `pulsar` in a Docker container preconfigured with all
optional dependencies needed to run a wide range of integration tests. If Docker
is to much of an ordeal many of Pulsar's tests can be executed by simply running
``nosetests`` from within an ``virtualenv`` configured as explained above.::
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
$ nosetests
6. Commit your changes and push your branch to GitHub::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
Pull Request Guidelines
-----------------------
Before you submit a pull request, check that it meets these guidelines:
1. If the pull request adds functionality, the docs should ideally be updated.
Put your new functionality into a function with a docstring. (Until the
@jmchilton learns to do this consistently this is only a suggestion though.)
2. The pull request should work for Python 2.6 and 2.7. Check
https://travis-ci.org/galaxyproject/planemo/pull_requests
and make sure that the tests pass for all supported Python versions. The
tests are imperfect and Travis sometimes fails in a transient fashion so
this also isn't strictly required to pass.
.. Tips
.. ----
.. To run a subset of tests::
.. $ nosetests test/name_of_test_file.py