Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 1.26 KB

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!):

git, npm, nodejs, VSCode, python3 (optional)

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

git clone [email protected]:<your-username>/vscode-mc-shader.git

Install dependencies:

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

If you dont have glslangValidator installed, run the following in the root directory of the repo and follow the instructions:
python3 setup.py

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, choose Launch Client in the debug menu or press F5.

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 where applicable.
  • Provide a good explanation of the changes provided. This helps me follow your code better.