Skip to content

Commit

Permalink
docs: improve CONTRIBUTING (#419)
Browse files Browse the repository at this point in the history
* feat: improve contributing docs

* fix: add missing link

Closes #356
  • Loading branch information
zaicevas committed Jul 20, 2021
1 parent c1ffc04 commit 5dff88e
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Thanks for being willing to contribute!
Working on your first Pull Request? You can learn how from this free series
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).

Tweaking ESLint rules is mostly about traversing through the AST. [AST Explorer](https://astexplorer.net) is a great tool that simplifies the process.

## Project setup

1. Fork this repository
Expand Down Expand Up @@ -63,8 +65,7 @@ each rule has three files named with its identifier (e.g. `no-debug`):

Additionally, you need to do a couple of extra things:

- Include your rule in the "Supported Rules" table within the [README.md](./README.md).
Don't forget to include the proper badges if needed and to sort alphabetically the rules for readability.
- Run `npm run generate:rules-list` to include your rule in the "Supported Rules" table within the [README.md](./README.md)

### Custom rule creator

Expand Down Expand Up @@ -113,6 +114,17 @@ A couple of things you need to remember when editing already existing rules:

## Writing Tests

If you wish to run a single test while developing locally, add `only: true` to the test case:

```javascript
valid: [
{
only: true,
code: `...`,
},
];
```

When writing tests for a new or existing rule, please make sure to follow these guidelines:

### Write real-ish scenarios
Expand Down

0 comments on commit 5dff88e

Please sign in to comment.