From be195e93e6bba893285681b325c412864c7547e9 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Thu, 6 Oct 2022 16:21:32 +0200 Subject: [PATCH] docs: add instruction to run the linter (#55) --- CONTRIBUTING.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ababae..5d24f44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.