-
Notifications
You must be signed in to change notification settings - Fork 10
Open
Description
from https://github.com/tree-sitter-grammars/.github/blob/main/CONTRIBUTING.md#requirements-for-inclusion
If you'd like your grammar to be included in this organization, please adhere to the following:
- Include corpus tests to ensure the parser works as expected.
- You may also include some example files to be parsed in CI.
- The queries must use the last-wins precedence (all queries are applied).
- Include highlight queries and their tests. Other queries are generally not necessary.
- The highlight captures should either use [Tree-sitter][STANDARD_CAPTURE_NAMES]'s
"standard" names, or [Neovim][treesitter-highlight-groups]'s names.
- The external scanner (if any) must be written in C and not C++.
- The grammar must be written in JavaScript and not TypeScript or anything else.
- You should be somewhat active in maintaining it. It's fine if there's no need for
maintenance, but you shouldn't let issues pile up for months to years on end. - You must follow [SemVer] for your grammar: breaking changes must result in a major bump,
new features in a minor bump, and bug fixes in a patch bump. - Commit messages should follow the [Conventional Commits] specification.
- Make sure all the metadata (names, links, versions, etc.) are correct and consistent.
- For example, the version in
package.jsonmust be the same as the one in `C
- For example, the version in
varadiz
Metadata
Metadata
Assignees
Labels
No labels