Update CONTRIBUTING.md #456
Conversation
|
|
||
| Once you've added your test case you'll want to then make the required changes | ||
| to `grammar.js`, regenerate and recompile the parser, and run the tests: | ||
|
|
||
| ```sh | ||
| npm run build | ||
| tree-sitter generate |
There was a problem hiding this comment.
Is this the command to use now? I see it is used in CI (https://github.com/tree-sitter/tree-sitter-scala/blob/master/.github/workflows/sync.yml#L27), but I’m not sure if anything else also needs to be called?
There was a problem hiding this comment.
I think the main testing CI script is https://github.com/tree-sitter/parser-test-action/blob/master/action.yml, and looks like it should be
tree-sitter generate
tree-sitter testI think.
CONTRIBUTING.md
Outdated
| [here](https://tree-sitter.github.io/tree-sitter/syntax-highlighting#unit-testing). These test will be automatically ran with `npm run test`. | ||
| type of testing | ||
| [here](https://tree-sitter.github.io/tree-sitter/3-syntax-highlighting.html#unit-testing). | ||
| These test will be run automatically with `npm run test`. |
There was a problem hiding this comment.
Is this still true? I only see node --test bindings/node/*_test.js in (package.json)[https://github.com/tree-sitter/tree-sitter-scala/blob/master/package.json#L50C14-L50C49]. CI seems like it has different actions for parser and binding tests.
There was a problem hiding this comment.
I think this is also tree-sitter test.
Some commands previous described in `CONTRIBUTING.md` have been removed, and some of the tree-sitter documentation links are broken. This PR updates `CONTRIBUTING.md` to fix these issues.
jonshea
force-pushed
the
jonshea/update-contributing-docs
branch
from
2872105 to
6b8b5f9
Compare
Some commands previous described in
CONTRIBUTING.mdhave been removed, and some of the tree-sitter documentation links are broken. This PR updatesCONTRIBUTING.mdto fix these issues.