Skip to content

Commit

Permalink
Update CONTRIBUTING.rst as per code style change
Browse files Browse the repository at this point in the history
  • Loading branch information
pradyunsg committed Mar 30, 2020
1 parent 7739025 commit 039e3dd
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,9 @@ data to the new models.
Code Convention
---------------

We follow the `Django Coding Style`_ and enforce it using `flake8`_.

In general, if flake8 is happy with your code, you should be fine. To use
``flake8`` to check your code, you can use the following command::

$ flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 <project_dir>/
We follow the `Black Coding Style`_, and sort our imports with `isort`_. This
code style is enforced with automation.

.. _`issue tracker`: https://github.com/pythonindia/junction/issues
.. _`flake8`: https://flake8.readthedocs.org/en/latest/
.. _`Django Coding Style`: https://docs.djangoproject.com/en/2.2/internals/contributing/writing-code/coding-style/
.. _`isort`: https://isort.readthedocs.org/en/latest/
.. _`Black Coding Style`: https://black.readthedocs.io/en/latest/the_black_code_style.html

0 comments on commit 039e3dd

Please sign in to comment.