Skip to content

Commit 936ed48

Browse files
authored
Add Contribution Guide (#1474)
1 parent d2d3aa2 commit 936ed48

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,26 @@ Discord: https://discord.gg/5bnSSSSBbK
6161
\* 🤝 support [take over mode](https://github.com/johnsoncodehk/volar/discussions/471) \
6262
\* 🅿️ support [extra preview features](https://twitter.com/johnsoncodehk/status/1507024137901916161)
6363

64+
## Contribution Guide
65+
66+
If you want to work on the volar extension follow these commands to setup your local development environment.
67+
68+
🔎 Note that you will need pnpm - you can download it here: https://pnpm.io/installation.
69+
70+
```bash
71+
git clone https://github.com/johnsoncodehk/volar.git
72+
cd volar
73+
pnpm install
74+
pnpm run build
75+
```
76+
77+
The recommended way to develop the volar extension is to use the [Debug Tools](https://code.visualstudio.com/Docs/editor/debugging) provided by VSCode.
78+
Alternatively you can run one of the scripts defined in the [package.json](https://github.com/johnsoncodehk/volar/blob/master/package.json) file.
79+
80+
❗ You should always use the debug launch configs or package.json scripts defined in the root of the project.
81+
82+
Additional info for contributing to open source projects is here: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
83+
6484
## High Level System Overview
6585

6686
```mermaid

0 commit comments

Comments
 (0)