CONTRIBUTING.rst

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.

Examples of contributions include:

• Code patches
• Documentation improvements
• Bug reports and patch reviews

For more information, please see our contribution guide.

Quick Setup

Fork, then clone the repo:

git clone [email protected]:your-username/channels.git

Make sure the tests pass:

python -m pip install -e .[tests,daphne]
pytest

Note

If you're using zsh for your shell, the above command will fail with a zsh: no matches found: .[tests] error. To fix this use noglob:

noglob python -m pip install -e .[tests]

Make your change. Add tests for your change. Make the tests pass:

tox

Make sure your code conforms to the coding style:

black ./channels ./tests
isort --check-only --diff --recursive ./channels ./tests

Push to your fork and submit a pull request.