Skip to content

Commit c140c89

Browse files
[change] Updated CSS and JS code conventions to mention prettier
Ref: openwisp/openwisp-utils#425 --------- Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
1 parent 17f6b7c commit c140c89

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

developer/contributing.rst

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -220,27 +220,38 @@ conventions which can be enforced by using the following tools:
220220
<http://flake8.pycqa.org/en/latest/>`_), for more info consult the
221221
documentation of :doc:`openwisp-qa-check </utils/developer/qa-checks>`.
222222

223-
Keep in mind that the QA checks defined in the ``run-qa-checks`` script
224-
are also executed in the CI builds, which will fail if any QA check fails.
223+
.. important::
224+
225+
QA checks defined in the ``run-qa-checks`` script are also executed in
226+
CI builds. These builds will fail if any QA check fails.
225227

226-
To fix QA check failures, run ``openwisp-qa-format`` and apply manual
227-
fixes if needed until ``./run-qa-checks`` runs without errors.
228+
To resolve QA check failures, run ``openwisp-qa-format`` and apply
229+
manual fixes if necessary, until ``./run-qa-checks`` completes without
230+
errors.
228231

229232
.. note::
230233

231234
If you want to learn more about our usage of python and django, we
232235
suggest reading :doc:`../developer/hacking-openwisp-python-django`.
233236

234-
2. Javascript code conventions
235-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237+
2. CSS and Javascript code conventions
238+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239+
240+
OpenWISP follows CSS and JavaScript coding conventions enforced by the
241+
`Prettier <https://prettier.io>`_ code formatting tool.
242+
243+
The Prettier formatter is used by the :doc:`openwisp-qa-format
244+
</utils/developer/qa-checks>` tool and by the `./run-qa-checks` script
245+
located in the top-level directory of each repository.
246+
247+
.. important::
248+
249+
QA checks defined in the ``run-qa-checks`` script are also executed in
250+
CI builds. These builds will fail if any QA check fails.
236251

237-
- OpenWISP follows standard JavaScript coding style conventions that are
238-
generally accepted or the ones that are specified in `.jshintrc files
239-
<https://github.com/openwisp/openwisp-controller/blob/master/.jshintrc>`_;
240-
find out more about `JSHint here <https://jshint.com/about/>`_
241-
- please follow this `JavaScript Style Guide and Coding Conventions
242-
<https://www.w3schools.com/js/js_conventions.asp>`_ link for proper
243-
explanation and wonderful examples
252+
To resolve QA check failures, run ``openwisp-qa-format`` and apply
253+
manual fixes if necessary, until ``./run-qa-checks`` completes without
254+
errors.
244255

245256
3. OpenWrt related conventions
246257
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)