mcshader-lsp/CONTRIBUTING.md
2018-06-04 21:39:59 +01:00

1.1 KiB

Contributing

Want to contribute? I sure want you to! Heres how you can help:

Setting up environment

Development requirements (did I miss any? Submit a PR!):

npm, nodejs, tslint, VSCode

Fork the repo (you are using SSH keys, right?):

git clone git@github.com:Strum355/vscode-mc-shader.git

Install dependencies:

cd vscode-mc-shader/server && npm i && cd ../client && npm i

Follow this link to learn your way around making extensions as well as here to learn a bit about the Language Server Protocol.

To test out your changes, simply choose Launch Client in the debug menu.

Submitting a Pull Request

Please adhere to the following guidelines before submitting a pull request:

  • Passes tslint checks with the given config.
  • Provide some comments in the code (see mine as an example).
  • Provide a good explanation of the changes provided. This helps me follow your code better.