benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-11 07:50:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add style-check script

Browse source
This commit is contained in:
Stephan Seitz 2020-07-05 20:45:46 +02:00 • committed by Thomas Vigouroux
parent ab1916f385
commit 27d7a0ffff
4 changed files with 23 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -11,6 +11,18 @@ As you know, `nvim-treesitter` is roughly splitted in two parts :
Depending on which part of the plugin you want to contribute to, please read the appropriate section.
## Style Checks and Tests
We haven't implemented any functionality tests yet. Feel free to contribute.
However, we check code style with `luacheck`!
Please install luacheck and activate our `pre-push` hook to automatically check style before
every push:
```bash
luarocks install luacheck
ln -s ../../scripts/pre-push .git/hooks/pre-push
```
## Parser configurations
Contributing to parser configurations is basically modifying one of the `queries/*/*.scm`.