Skip to content

Latest commit

聽

History

History
41 lines (24 loc) 路 1.17 KB

contributing.md

File metadata and controls

41 lines (24 loc) 路 1.17 KB
Raw

Contributing

Hello! It's great that you are interested in contributing to ESLint Plugin Perfectionist. Before submitting your contribution, please take a moment to read the following guide:

Installation

This project uses the pnpm package manager. Therefore, to work with the project, you need to install it.

How to set up a project locally and run tests:

  1. Clone repo:
git clone git@github.com:azat-io/eslint-plugin-perfectionist.git
  1. Install dependencies:
pnpm install
  1. Run tests:
pnpm test

Pull Request Guidelines

Before create pull request fork this repo and create a new branch.

ESLint Plugin Perfectionist aims to be lightweight, so think before adding new dependencies to your project.

Commit messages must follow the commit message convention so that changelogs can be automatically generated.

Make sure tests pass.

Additional information

This plugin uses @typescript/eslint-parser. When developing, I recommend using AST explorer. It makes development much easier.