daphne/CONTRIBUTING.rst
Landon Jurgens 5969bbd0f3 Initial implementation of the contribution file
Added IDE/TOOLS section to .gitignore
2016-07-21 12:21:12 -04:00

34 lines
883 B
ReStructuredText

Contributing to Channels
========================
As an open source project, Channels welcomes contributions of many forms.By participating in this project, you
agree to abide by the Django `code of conduct <https://www.djangoproject.com/conduct/>`_.
Examples of contributions include:
* Code patches
* Documentation improvements
* Bug reports and patch reviews
Setup
-----
Fork, then clone the repo:
git clone git@github.com:your-username/channels.git
Make sure the tests pass:
tox
Make your change. Add tests for your change. Make the tests pass:
tox
Push to your fork and `submit a pull request <https://github.com/andrewgodwin/channels/compare/>`_.
At this point you're waiting on us. We like to at least comment on pull requests
within three business days (and, typically, one business day). We may suggest
some changes or improvements or alternatives.