Skip to content

Commit 5fa3721

Browse files
committed
docs: add Project Setup section to Developer Guide
1 parent ebf6cb5 commit 5fa3721

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/developer-guide/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Contributing is welcome.
44

5+
## Project Setup
6+
7+
To develop locally, fork the eslint-plugin-vue repository and clone it in your local machine. The package manager used to install and link dependencies must be [npm](https://www.npmjs.com/). You need to use the LTS version of [Node.js](https://nodejs.org/).
8+
9+
To develop and test the `eslint-plugin-vue` package:
10+
11+
1. Run `npm install` in the project's root folder.
12+
13+
2. Run `npm test` to make sure everything is set up correctly.
14+
515
## :bug: Bug reporting
616

717
If you think you’ve found a bug in ESLint, please [create a new issue](https://github.com/vuejs/eslint-plugin-vue/issues/new?labels=&template=bug_report.md) or a pull request on GitHub.

0 commit comments

Comments
 (0)