From 390450c0f1ff646272cab646f208adc9d23a00bb Mon Sep 17 00:00:00 2001 From: Kim K Date: Mon, 10 Jun 2019 09:52:26 +0200 Subject: [PATCH] feat(README): Add more clarification for the Contributing -> Linting section --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6fa52ed..96513977 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Using plug: # Configuration -Run `:help doge-config` to get the help page for all the possible configuration. + ### `g:doge_mapping` @@ -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` @@ -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