mirror of
https://github.com/django/daphne.git
synced 2025-07-10 16:02:18 +03:00
Merge pull request #263 from slick666/contribution_document
Contribution document
This commit is contained in:
commit
4d580c2575
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -7,4 +7,8 @@ __pycache__/
|
||||||
.tox/
|
.tox/
|
||||||
*.swp
|
*.swp
|
||||||
*.pyc
|
*.pyc
|
||||||
|
.coverage.*
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
|
IDE and Tooling files
|
||||||
|
.idea/*
|
33
CONTRIBUTING.rst
Normal file
33
CONTRIBUTING.rst
Normal 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.
|
Loading…
Reference in New Issue
Block a user