Skip to content

Commit

Permalink
Add Contribution Guide (#1474)
Browse files Browse the repository at this point in the history
  • Loading branch information
IIFelix committed Jun 18, 2022
1 parent d2d3aa2 commit 936ed48
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Expand Up @@ -61,6 +61,26 @@ Discord: https://discord.gg/5bnSSSSBbK
\* 🤝 support [take over mode](https://github.com/johnsoncodehk/volar/discussions/471) \
\* 🅿️ support [extra preview features](https://twitter.com/johnsoncodehk/status/1507024137901916161)

## Contribution Guide

If you want to work on the volar extension follow these commands to setup your local development environment.

🔎 Note that you will need pnpm - you can download it here: https://pnpm.io/installation.

```bash
git clone https://github.com/johnsoncodehk/volar.git
cd volar
pnpm install
pnpm run build
```

The recommended way to develop the volar extension is to use the [Debug Tools](https://code.visualstudio.com/Docs/editor/debugging) provided by VSCode.
Alternatively you can run one of the scripts defined in the [package.json](https://github.com/johnsoncodehk/volar/blob/master/package.json) file.

❗ You should always use the debug launch configs or package.json scripts defined in the root of the project.

Additional info for contributing to open source projects is here: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

## High Level System Overview

```mermaid
Expand Down

0 comments on commit 936ed48

Please sign in to comment.