Merge pull request #263 from slick666/contribution_document

Contribution document
This commit is contained in:
Andrew Godwin 2016-07-21 13:08:12 -04:00 committed by GitHub
commit 4d580c2575
2 changed files with 37 additions and 0 deletions

4
.gitignore vendored
View File

@ -7,4 +7,8 @@ __pycache__/
.tox/
*.swp
*.pyc
.coverage.*
TODO
IDE and Tooling files
.idea/*

33
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,33 @@
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.