diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be58012b..68f7042c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,16 @@ ## Requirements -- [Neovim](https://neovim.io/) :P +- [Neovim](https://neovim.io/) 0.5 or later - Documentation is generated by `scripts/docgen.lua`. - Only works on unix, you can ignore it on Windows. -- Lint task requires [luacheck](https://github.com/luarocks/luacheck#installation). +- Lint task requires [luacheck](https://github.com/luarocks/luacheck#installation) and [stylua](https://github.com/JohnnyMorganz/StyLua). ## Lint -PRs are checked with Luacheck. To run the linter locally: +PRs are checked with Luacheck and stylua. To run the linter locally: make lint + stylua . ## Generating docs |