docs: add instruction to run the linter (#55)

This commit is contained in:
Ayo Ayco 2022-10-06 16:21:32 +02:00 committed by GitHub
parent a5d5b35376
commit be195e93e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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.