1434332 - Add a checklist for adding new linters to the tree

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[Mark Banner (:standard8)]

As we add new linters to the tree, we should also ensure that we have some basic requirements so that we get everything we need from the outset (or landed in a way which doesn't adversely affect developers).

We can add this into the existing linter documentation.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1434332 - Add a checklist for adding new linters to the tree.

Review commit: https://reviewboard.mozilla.org/r/216672/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/216672/

Comment 2

[Andrew Halberstadt [:ahal]]

Comment on attachment 8946702 [details]
Bug 1434332 - Add a checklist for adding new linters to the tree.

https://reviewboard.mozilla.org/r/216672/#review222488

::: tools/lint/docs/create.rst:13
(Diff revision 1)
> +
> +* Any required dependencies should be installed as part of `./mach bootstrap`
> +* A ``./mach lint`` interface
> +* Running ``./mach lint`` command must pass (note, linters can be disabled for individual directories)
> +* Taskcluster/Treeherder integration
> +* In tree documentation (under ``lint/docs``) to give a basic summary, links and any other useful information

nit: tools/lint/docs

Comment 3

[Mark Banner (:standard8)]

Comment on attachment 8946702 [details]
Bug 1434332 - Add a checklist for adding new linters to the tree.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/216672/diff/1-2/

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/82352a076662
Add a checklist for adding new linters to the tree. r=ahal

Comment 5

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/82352a076662