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.
Fork, then clone the repo:
git clone git@github.com:your-username/channels.gitMake sure the tests pass:
python -m pip install -e .[tests,daphne]
pytestNote
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:
toxMake sure your code conforms to the coding style:
black ./channels ./tests
isort --check-only --diff --recursive ./channels ./testsPush to your fork and submit a pull request.