vscode-gradle/CONTRIBUTING.md

# Contributing

## How to contribute

Start by opening an issue using one of the issue templates, or propose a change by submitting a pull request. Please include a detailed pull request description.

## Running the project

1. Install [nvm](https://github.com/nvm-sh/nvm)
2. Install protobuf compiler: `brew install protobuf`
3. Install [Java version >= 8](https://adoptopenjdk.net/)
4. Change directory to the root of the project
5. Select Node version: `nvm use`
6. Install Node packages: `npm install`
7. Build Java lib: `npm run compile:java`
8. Build proto lib: `npm run compile:proto`

Now open the root of the project in VS Code, click on the Debug panel, and select either "Run Extension" or any of the test launch configurations.

### Code style

Prettier is used to lint & format the code. The builds will not pass if there are linting issues.

- Lint: `npm run lint`
- Fix linting issues: `npm run lint:fix`