diff options
| author | w0rp <w0rp@users.noreply.github.com> | 2016-10-07 16:44:25 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-07 16:44:25 +0100 |
| commit | f0f17e4b0d472dd180c6f4b92aa8c28c550d3f7f (patch) | |
| tree | 7b643bfd231d8a9d34e715a60fc725390db79afd /CONTRIBUTING.md | |
| parent | 0e986359377ee1da1c2f5ec14155fd3a6bc548f0 (diff) | |
| download | ale-f0f17e4b0d472dd180c6f4b92aa8c28c550d3f7f.zip | |
Explain that options should be documented.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 238e282a..9aa11446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,3 +36,10 @@ consider pulling it up into the [handlers.vim](plugin/ale/handlers.vim) file, an When you add a linter, make sure the language for the linter and the linter itself are present in the table in the [README.md](README.md) file and in the Vim [help file](doc/ale.txt). The programs and linters are sorted alphabetically in the table and list. + +# 2.2. Adding New Options + +If you add new options to the plugin, make sure to document those new options in the [README.md](README.md) file, and also +in the [help file](doc/ale.txt). Follow the format of other options in each. Global options should appear in the README +file, and in the relevant section in the help file, and options specific to a particular linter should go in the section +for that linter. |