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

fix(CONTRIBUTING): typos

Browse source
This commit is contained in:
Thomas Vigouroux 2020-05-07 09:26:02 +02:00
parent 22f73628f6
commit c6b0a62bd6
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -3,11 +3,11 @@
First of all, thank you very much for contributing to `nvim-treesitter`. First of all, thank you very much for contributing to `nvim-treesitter`.
If you haven't already, you should really come and reach out to us on our [gitter](https://gitter.im/nvim-treesitter/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link) If you haven't already, you should really come and reach out to us on our [gitter](https://gitter.im/nvim-treesitter/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
room, so that we can help you contributing ! room, so we can help you with any question you might have!
As you know, `nvim-treesitter` is roughly splitted in two parts : As you know, `nvim-treesitter` is roughly splitted in two parts :
- Parser configurations : for various things like `locals`, `highlights` - Parser configurations : for various things like `locals`, `highlights`
- What we like to call *modules* : tiny lua modules that provide a given featurs, based on parser configurations - What we like to call *modules* : tiny lua modules that provide a given feature, based on parser configurations
Depending on which part of the plugin you want to contribute to, please read the appropriate section. Depending on which part of the plugin you want to contribute to, please read the appropriate section.
@ -20,9 +20,9 @@ Before going any further, we highly suggest that you [read more about tree-sitte
Each query has an appropriate name, which is then used by modules to extract data from the syntax tree. Each query has an appropriate name, which is then used by modules to extract data from the syntax tree.
For now two types of queries are used by `nvim-treesitter`: For now two types of queries are used by `nvim-treesitter`:
- `highlights.scm` : used for syntax highlighting, using the `highlight` module. - `highlights.scm` : used for syntax highlighting, using the `highlight` module.
- `locals.scm` : used to exctract keyword definitions, scopes, references,... using the `locals` module. - `locals.scm` : used to extract keyword definitions, scopes, references,... using the `locals` module.
For both of thses types there is a *norm* you will have to follow so that features work fine. For both of these types there is a *norm* you will have to follow so that features work fine.
Here are some global advices : Here are some global advices :
- If your language is listed [here](https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries), - If your language is listed [here](https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries),
you can debug and experiment with your queries there. you can debug and experiment with your queries there.
@ -33,7 +33,7 @@ Here are some global advices :
### Highlights ### Highlights
As languages differ quite a lot, here is a set of captures available to you when building a `highlights.scm` query. As languages differ quite a lot, here is a set of captures available to you when building a `highlights.scm` query.
On important thing to note is that many of these capture groups are not supported by `neovim` for now, and will not have any One important thing to note is that many of these capture groups are not supported by `neovim` for now, and will not have any
effect on highlighting. We will work on improving highlighting in the near future though. effect on highlighting. We will work on improving highlighting in the near future though.
#### Misc #### Misc