docs: add instruction to run the linter (#55)
This commit is contained in:
parent
a5d5b35376
commit
be195e93e6
1 changed files with 13 additions and 2 deletions
|
@ -66,13 +66,24 @@ npm start
|
|||
https://localhost:3000
|
||||
```
|
||||
|
||||
# Running package tests
|
||||
# Running the linter and tests
|
||||
|
||||
Please run the linter and tests before creating a PR to avoid delays in PR reviews. Fix all linting errors or failing tests whey you run the following commands.
|
||||
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
|
||||
Please run the tests before creating a PR to make sure nothing is broken.
|
||||
```
|
||||
npm test
|
||||
```
|
||||
|
||||
✨ _HINT: Some linting errors could automatically fixed with a command_
|
||||
|
||||
```
|
||||
npm run lint:fix
|
||||
```
|
||||
|
||||
# Hacking with the packages
|
||||
|
||||
As mentioned above, this project involves packages that are intened to be used in Astro applications. The demo app is our way to test and play with the packages.
|
||||
|
|
Loading…
Reference in a new issue