Skip to content

Commit 58b32cc

Browse files
committed
[docs] Made general OpenWISP contributing guidelines more evident
- link general openwisp contributing guidelines - advise to run openwisp-qa-format - advise to run run-qa-checks script
1 parent 93e0bb1 commit 58b32cc

1 file changed

Lines changed: 15 additions & 18 deletions

File tree

docs/source/general/contributing.rst

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,13 @@ Follow these guidelines to speed up the process.
1212
:backlinks: none
1313
:depth: 3
1414

15-
Reach out before you start
16-
--------------------------
15+
General contributing guidelines of OpenWISP
16+
-------------------------------------------
1717

18-
Before opening a new issue, try the following steps:
19-
20-
- look if somebody else has already started working on the same issue
21-
by looking in the `github issues <https://github.com/openwisp/netjsonconfig/issues>`_
22-
and `pull requests <https://github.com/openwisp/netjsonconfig/pulls>`_
23-
- look also in the `OpenWISP mailing list <https://groups.google.com/d/forum/openwisp/join>`_
24-
- announce your intentions by opening a new issue
25-
- present yourself on the mailing list
18+
We highly recommend reading the general
19+
`OpenWISP Contributing Guidelines <https://openwisp.io/docs/developer/contributing.html>`_
20+
to find out the conventions we use to maintain consistency and quality standards
21+
across the different OpenWISP modules.
2622

2723
Create a virtual environment
2824
----------------------------
@@ -69,8 +65,8 @@ When you introduce changes, ensure test coverage is not decreased with:
6965
7066
nose2 --with-coverage --coverage netjsonconfig
7167
72-
Follow style conventions (PEP8, isort)
73-
--------------------------------------
68+
Follow the coding style conventions and run the QA checks
69+
---------------------------------------------------------
7470

7571
First of all, install the test requirements:
7672

@@ -79,17 +75,18 @@ First of all, install the test requirements:
7975
workon netjsonconfig # activate virtualenv
8076
pip install -r requirements-test.txt
8177
82-
Before committing your work check that your changes are not breaking the style conventions with:
78+
Before committing your work, run ``openwisp-qa-format`` to format the code according
79+
to our `python code conventions <https://openwisp.io/docs/developer/contributing.html#python-code-conventions>`_:
8380

8481
.. code-block:: shell
8582
86-
flake8
87-
isort --check-only --recursive .
83+
openwisp-qa-format
8884
89-
For more information, please see:
85+
Then, you can run the QA checks with:
86+
87+
.. code-block:: shell
9088
91-
- `PEP8: Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_
92-
- `isort: a python utility / library to sort imports <https://github.com/timothycrosley/isort>`_
89+
./run-qa-checks
9390
9491
Update the documentation
9592
------------------------

0 commit comments

Comments
 (0)