diff options
| author | Thomas Vigouroux <tomvig38@gmail.com> | 2020-07-08 09:46:54 +0200 |
|---|---|---|
| committer | Stephan Seitz <stephan.lauf@yahoo.de> | 2020-07-08 11:48:47 +0200 |
| commit | 6ce0235e74e7e7f4716dad10224c27dad63babea (patch) | |
| tree | 8b74b2bf5db2c28c16c18e1474b8e38ff95404a5 | |
| parent | fix(refactor): highlight def perf issue fix (diff) | |
| download | nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar.gz nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar.bz2 nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar.lz nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar.xz nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.tar.zst nvim-treesitter-6ce0235e74e7e7f4716dad10224c27dad63babea.zip | |
docs: advertise module-template in CONTRIBUTING.md
| -rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47dcb9f83..9b88e11bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ Depending on which part of the plugin you want to contribute to, please read the ## 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`! Please install luacheck and activate our `pre-push` hook to automatically check style before every push: @@ -23,6 +23,21 @@ luarocks install luacheck 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 Contributing to parser configurations is basically modifying one of the `queries/*/*.scm`. |
