Bug 1434332 - Add a checklist for adding new linters to the tree. r=ahal

MozReview-Commit-ID: FnYIXS5oZvW

--HG--
extra : rebase_source : 2eba61a24a4ca313f3c1d65adef454e34c57bdb5
This commit is contained in:
Mark Banner 2018-01-30 16:55:20 +00:00
Родитель da943dc517
Коммит 15e66f33ed
1 изменённых файлов: 14 добавлений и 0 удалений

Просмотреть файл

@ -1,6 +1,20 @@
Adding a New Linter to the Tree
===============================
Linter Requirements
-------------------
For a linter to be integrated into the mozilla-central tree, it needs to have:
* 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 ``tools/lint/docs``) to give a basic summary, links and any other useful information
Linter Basics
-------------
A linter is a yaml file with a ``.yml`` extension. Depending on how the type of linter, there may
be python code alongside the definition, pointed to by the 'payload' attribute.