Skip to content

Commit

Permalink
feat(README): Add more clarification for the Contributing -> Linting …
Browse files Browse the repository at this point in the history
…section
  • Loading branch information
kkoomen committed Jun 10, 2019
1 parent 79cd39e commit 390450c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Using plug:

# Configuration

Run `:help doge-config` to get the help page for all the possible configuration.
<!-- Run `:help doge-config` to get the help page for all the possible configuration. -->

### `g:doge_mapping`

Expand All @@ -91,7 +91,9 @@ request.
## Linting

Your pull request should follow the rules of the `vim-vint` linter which is a
must to keep your code clean and prevent mistakes being made.
must to keep the code clean and prevent mistakes being made. Each PR will
automatically run tests for code quality using Vint. You don't have to use Vint
locally, but it will help you to fix any errors before submitting a PR.

- `pip3 install vim-vint`

Expand All @@ -109,7 +111,8 @@ let g:syntastic_vim_checkers = ['vint']
## Documentation

Every function, mapping or configurable option should contain documentation. The
documentation in the `doc/` should be generated using [vimdoc](https://github.com/google/vimdoc).
documentation in the `doc/` should be generated using
[vimdoc](https://github.com/google/vimdoc).

## Help

Expand Down

0 comments on commit 390450c

Please sign in to comment.