Bug 1686226 - Add references to the Matrix Lint & Formatting room in the coding style docs. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D101463
This commit is contained in:
@@ -4,9 +4,17 @@ Coding style
|
||||
Firefox code is using different programming languages.
|
||||
For each language, we are enforcing a specific coding style.
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
If you need help or have questions, please don’t hesitate to contact us via Matrix
|
||||
in the "Lint and Formatting" room
|
||||
(`#lint:mozilla.org <https://chat.mozilla.org/#/room/#lint:mozilla.org>`_).
|
||||
|
||||
|
||||
.. toctree::
|
||||
:caption: Coding Style User Guide
|
||||
:maxdepth: 2
|
||||
:glob:
|
||||
|
||||
*
|
||||
|
||||
|
||||
@@ -21,6 +21,13 @@ different kinds of linters in all of these different places could quickly balloo
|
||||
``Mozlint`` isn't designed to be used directly by end users. Instead, it can be consumed by things
|
||||
like mach, phabricator and taskcluster.
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
If you need help or have questions, please don’t hesitate to contact us via Matrix
|
||||
in the "Lint and Formatting" room
|
||||
(`#lint:mozilla.org <https://chat.mozilla.org/#/room/#lint:mozilla.org>`_).
|
||||
|
||||
.. toctree::
|
||||
:caption: Linting User Guide
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
Linting
|
||||
=======
|
||||
|
||||
Linters are used in mozilla-central to help enforce coding style and avoid bad practices. Due to the
|
||||
wide variety of languages in use, this is not always an easy task. In addition, linters should be runnable from editors, from the command line, from review tools
|
||||
and from continuous integration. It's easy to see how the complexity of running all of these
|
||||
different kinds of linters in all of these different places could quickly balloon out of control.
|
||||
|
||||
``Mozlint`` is a library that accomplishes several goals:
|
||||
|
||||
1. It provides a standard method for adding new linters to the tree, which can be as easy as
|
||||
defining a config object in a ``.yml`` file. This helps keep lint related code localized, and
|
||||
prevents different teams from coming up with their own unique lint implementations.
|
||||
2. It provides a streamlined interface for running all linters at once. Instead of running N
|
||||
different lint commands to test your patch, a single ``mach lint`` command will automatically run
|
||||
all applicable linters. This means there is a single API surface that other tools can use to
|
||||
invoke linters.
|
||||
3. With a simple taskcluster configuration, Mozlint provides an easy way to execute all these jobs
|
||||
at review phase.
|
||||
|
||||
``Mozlint`` isn't designed to be used directly by end users. Instead, it can be consumed by things
|
||||
like mach, phabricator and taskcluster.
|
||||
|
||||
.. toctree::
|
||||
:caption: Linting User Guide
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
usage
|
||||
create
|
||||
linters/*
|
||||
Reference in New Issue
Block a user