CONTRIBUTING.md

How to Contribute

We accept patches!

Workflow

To start working on a feature or fix (on Github):

1. Fork ZKTraffic
2. Make a feature branch
3. Work on your feature or bugfix
4. Write a test for your change
5. From your branch, make a pull request against twitter/zktraffic/master

Testing

ZKTraffic uses nose for tests. All tests go in zktraffic/tests.

To run the tests:

$ python setup.py nosetests

Style

Make sure your code is PEP8 compliant and workes with Py2.7 and Py3K.