File: CONTRIBUTING.rst

package info (click to toggle)
python-django-channels 4.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,036 kB
  • sloc: python: 3,109; makefile: 155; javascript: 60; sh: 8
file content (51 lines) | stat: -rw-r--r-- 1,292 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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

For more information, please see our `contribution guide <https://channels.readthedocs.io/en/latest/contributing.html>`_.

Quick Setup
-----------

Fork, then clone the repo:

.. code-block:: sh

    git clone git@github.com:your-username/channels.git

Make sure the tests pass:

.. code-block:: sh

    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:

.. code-block:: sh

    tox

Make sure your code conforms to the coding style:

.. code-block:: sh

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

Push to your fork and `submit a pull request <https://github.com/django/channels/compare/>`_.