From 5fa3721a4743e53bd78a9125de5d3a399df1b081 Mon Sep 17 00:00:00 2001 From: 2nofa11 Date: Fri, 4 Jul 2025 22:03:21 +0900 Subject: [PATCH 1/4] 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. From 659301992df1e95d81ff7a07675d3c2f56781595 Mon Sep 17 00:00:00 2001 From: 2nofa11 <47783146+2nofa11@users.noreply.github.com> Date: Wed, 9 Jul 2025 21:31:07 +0900 Subject: [PATCH 2/4] Update docs/developer-guide/index.md Co-authored-by: Flo Edelmann --- docs/developer-guide/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index 27c308199..a39d6c46a 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -9,7 +9,6 @@ To develop locally, fork the eslint-plugin-vue repository and clone it in your l 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 From 8ce3b11eb5f0c72675a938f7597d1aed8d1dc518 Mon Sep 17 00:00:00 2001 From: 2nofa11 <47783146+2nofa11@users.noreply.github.com> Date: Wed, 9 Jul 2025 21:31:25 +0900 Subject: [PATCH 3/4] Update docs/developer-guide/index.md Co-authored-by: Flo Edelmann --- docs/developer-guide/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index a39d6c46a..58523aa48 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -4,7 +4,7 @@ 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 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/). To develop and test the `eslint-plugin-vue` package: From e152fedb3ae790db71d5c17dd3483887228c4dc1 Mon Sep 17 00:00:00 2001 From: 2nofa11 Date: Wed, 9 Jul 2025 23:15:57 +0900 Subject: [PATCH 4/4] docs: move Project Setup section below Bug Reporting and add emoji --- docs/developer-guide/index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index 58523aa48..9bfc68007 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -2,7 +2,13 @@ Contributing is welcome. -## Project Setup +## :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. + +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. + +## :seedling: Project Setup 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/). @@ -11,12 +17,6 @@ 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. - -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. - ## :sparkles: Proposing a new rule or a rule change In order to add a new rule or a rule change, you should: