Skip to content

Commit

Permalink
docs: add lint section to intro to contributing (open-sauced#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
diivi authored Mar 24, 2023
1 parent ebff9f5 commit b427242
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/contributing/introduction-to-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,26 @@ npm test

For more info on testing React and JavaScript, check out this course [Testing JavaScript](https://testingjavascript.com/)

## Applying Lint Styleguide

To check the code for formatting and linting errors, run the following command:

```shell
npm run lint
```

These errors will also be displayed during development, but won't prevent the code from compiling.

To fix the formatting and linting errors, run the following command instead:

```shell
npm run format
```

These commands use [ESLint](https://eslint.org/) to check and fix the code.

The automated PR checks will also run these commands, and the PR will be blocked if there are any errors, so it's a good idea to run them before submitting a PR.

## Pull requests

**_We actively welcome your pull requests, however linking your work to an existing issue is preferred._**
Expand Down

0 comments on commit b427242

Please sign in to comment.