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

docs: advertise module-template in CONTRIBUTING.md

Browse source
This commit is contained in:
Thomas Vigouroux 2020-07-08 09:46:54 +02:00
parent 884080f89a
commit 494e801f4d
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -13,7 +13,7 @@ Depending on which part of the plugin you want to contribute to, please read the
## Style Checks and Tests ## Style Checks and Tests
We haven't implemented any functionality tests yet. Feel free to contribute. We haven't implemented any functional tests yet. Feel free to contribute.
However, we check code style with `luacheck`! However, we check code style with `luacheck`!
Please install luacheck and activate our `pre-push` hook to automatically check style before Please install luacheck and activate our `pre-push` hook to automatically check style before
every push: every push:
@ -23,6 +23,21 @@ luarocks install luacheck
ln -s ../../scripts/pre-push .git/hooks/pre-push ln -s ../../scripts/pre-push .git/hooks/pre-push
``` ```
## Adding new modules
If you want to see a new functionality added to `nvim-treesitter` feel free to first open an issue
to that we can track our solution !
Thus far, there is basically two types of modules:
- Little modules (like `incremental selection`) that are built in `nvim-treesitter`, we call them
`builtin modules`.
- Bigger modules (like `completion-treesitter`, or `nvim-tree-docs`), or modules that integrate
with other plugins, that we call `remote modules`.
In any case, you can build your own module ! To help you started in the process, we have a template
repository designed to build new modules [here](https://github.com/nvim-treesitter/module-template).
Feel free to use it, and contact us over on our
[gitter](https://gitter.im/nvim-treesitter/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link).
## Parser configurations ## Parser configurations
Contributing to parser configurations is basically modifying one of the `queries/*/*.scm`. Contributing to parser configurations is basically modifying one of the `queries/*/*.scm`.