Skip to content

Commit

Permalink
Update contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmeuli committed Jan 1, 2020
1 parent ddb234a commit 4bcd461
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,10 @@ If you want to add support for an additional linter, please open an issue to dis

- Clone the repository and install its dependencies with `yarn install`.
- Create a new class for the linter, e.g. `src/linters/my-linter.js`. Have a look at the other files in that directory to see what functions the class needs to implement.
- Import your class in the `src/linters/index.js` file.
- Import your class in the [`src/linters/index.js`](./src/linters/index.js) file.
- Provide a sample project for the linter under `test/linters/projects/my-linter/`. It should be simple and contain a few linting errors which your tests will detect.
- Provide the expected linting output for your sample project in a `test/linters/params/my-linter.js` file. Again, see the other test files in the directory for inspiration. You can run the tests with `yarn test`.
- Update the [`action.yml`](./action.yml) file with the options the new linter provides.
- Provide the expected linting output for your sample project in a `test/linters/params/my-linter.js` file. Import this file in [`test/linters/linters.test.js`](./test/linters/linters.test.js). You can run the tests with `yarn test`.
- Update the [`action.yml`](./action.yml) file with the options provided by the new linter.
- Mention your linter in the [`README.md`](./README.md) file.

## Related
Expand Down

0 comments on commit 4bcd461

Please sign in to comment.