Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add linter instructions to README #32

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add linter instructions to README #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
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