Skip to content

Commit 3d9e15e

Browse files
2nofa11FloEdelmann
andauthored
docs: add Project Setup section to Developer Guide (#2780)
Co-authored-by: Flo Edelmann <git@flo-edelmann.de>
1 parent a2e49a7 commit 3d9e15e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/developer-guide/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ If you think you’ve found a bug in ESLint, please [create a new issue](https:/
88

99
Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that’s time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues.
1010

11+
## :seedling: Project Setup
12+
13+
To develop locally, fork the eslint-plugin-vue repository and clone it in your local machine. Use the [npm](https://www.npmjs.com/) package manager to install and link dependencies and the LTS version of [Node.js](https://nodejs.org/).
14+
15+
To develop and test the `eslint-plugin-vue` package:
16+
17+
1. Run `npm install` in the project's root folder.
18+
2. Run `npm test` to make sure everything is set up correctly.
19+
1120
## :sparkles: Proposing a new rule or a rule change
1221

1322
In order to add a new rule or a rule change, you should:

0 commit comments

Comments
 (0)