From 5fa3721a4743e53bd78a9125de5d3a399df1b081 Mon Sep 17 00:00:00 2001 From: 2nofa11 Date: Fri, 4 Jul 2025 22:03:21 +0900 Subject: [PATCH] docs: add Project Setup section to Developer Guide --- docs/developer-guide/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index 2e1bb7da9..27c308199 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -2,6 +2,16 @@ Contributing is welcome. +## Project Setup + +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/). + +To develop and test the `eslint-plugin-vue` package: + +1. Run `npm install` in the project's root folder. + +2. Run `npm test` to make sure everything is set up correctly. + ## :bug: Bug reporting 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.