CONTRIBUTING.md

Contributing

Installing Dependencies

We use yarn for managing dependencies. You can install the necessary dependencies using the following command:

yarn install

Running Tests

When making changes to lint rules, you can re-run the tests with the following command:

yarn test

Or run it in watch mode like so:

yarn test --watch

Adding new rules

When adding new rules, make sure to follow these steps:

1. Add the rule source code in src/rules
2. Add tests for the rule in src/rules
3. Add docs for the rule to docs/rules
4. Add the rule to the index.ts
5. Add a short description of the rule in README.md

Releasing

To release a new version with semantic-release, run the following command.

gh workflow run release.yml