Skip to content

docs: add Project Setup section to Developer Guide #2780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 9, 2025
Merged

docs: add Project Setup section to Developer Guide #2780

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fa3721
docs: add Project Setup section to Developer Guide
2nofa11 Jul 4, 2025
6593019
Update docs/developer-guide/index.md
2nofa11 Jul 9, 2025
8ce3b11
Update docs/developer-guide/index.md
2nofa11 Jul 9, 2025
e152fed
docs: move Project Setup section below Bug Reporting and add emoji
2nofa11 Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/developer-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ If you think you’ve found a bug in ESLint, please [create a new issue](https:/

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/).

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.

## :sparkles: Proposing a new rule or a rule change

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