Skip to content

Commit

Permalink
Add linter instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
kewisch committed Aug 7, 2024
1 parent 48d91f5 commit 5303e83
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,19 @@ completed the following:
* The API follows the design principles laid out in this README.
* The API code must be made available under the terms of the
[Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/).
* The API code is contained in a sub directory and passes the linters (`npm run lint`).
* The API code is contained in a sub directory and passes the linters.
* There is a reference to the API in this README file, along with a short description.

To run the linters, follow these steps
```bash
npm install
npm run lint

# To add arguments to eslint you need to double the -- to separate arguments
# This command will fix any eslint issues that can be fixed automatically
npm run lint -- --fix
```

Each experiment should also contain this table to summarize common information. Not everything needs
to be filled in from the start, but it will help over the course of the experiment.

Expand Down

0 comments on commit 5303e83

Please sign in to comment.