Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (21 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.1 KB

Contributing Guide

Thanks for your interest in contributing to Go Syntax!

Any kind of PR (e.g., tests, performance improvements, bug fixes, features, typos) is welcome!

We include a simple scenario demonstrating each change in semantic_tokens.go. We take advantage of Git version control to test changes. Eventually, running tests will generate snapshot files, and we will be able to see the differences. This helps us to ensure that we are not breaking anything in the existing sample code.

Test

Please add a sample of Go code related to your PR in semantic_tokens.go. Refer to the Makefile for detailed test commands.

You need to install vscode-tmgrammar-test before running the tests.

Install it globally:

npm i -g vscode-tmgrammar-test

In the go-syntax directory, run the following tests:

  1. Stress Test

    make stress

  2. Semantic Tokens Test

    make ready

Many changes may occur in the tests depending on your PR, which is fine.