nvim-treesitter / nvim-treesitter

Nvim Treesitter configurations and abstraction layer
Apache License 2.0
10.85k stars 901 forks source link

improve documentation / tooling for contributions #3837

Open kevinushey opened 2 years ago

kevinushey commented 2 years ago

As part of trying to update the R tree-sitter grammar, I had trouble figuring out how to replicate failing CI tests locally (as the grammar changes would require some changes to the queries bundled in this repository).

It would be helpful if there were some of the following:

  1. Helper scripts to make it easier to bootstrap the requisite testing environment;
  2. Documentation as to how one could prepare their local environment.

There are some helper scripts in (1), but they're not documented and seem somewhat tied to pre-requisites that only happen in CI. See e.g.

https://github.com/nvim-treesitter/nvim-treesitter/blob/master/.github/workflows/tests.yml#L33-L46

Some things that I believe would be helpful to see:

I'm guessing most of this is obvious for someone familiar with the neovim ecosystem, but for those of us who are not such instructions would be incredibly helpful. Thanks for taking the time for consider!

clason commented 2 years ago

These are valid points, thank you for raising them!