X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=4142a351215a766314be2e1dd18724d1cead8cb0;hb=fb7b29219d513a3a5465accf79c9eea02c04e345;hp=50957aa3078a91e57448add6643a600096b30fcc;hpb=53ba26617bbaf5363baf7f8a8b31a52465ff4ade;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50957aa3..4142a351 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,12 +7,11 @@ Another thing that you can do to contribute is to build something on top of ring Please ask your PR to be merged on **master** branch. -**How to run tests** - -**Unit tests** +**How to run unit tests and coverage** ```bash - npm run test + npm test + npm run coverage ``` **How to check if your new code is standard style** @@ -21,17 +20,18 @@ Please ask your PR to be merged on **master** branch. npm run lint ``` -**How to lint and format (with prettier) your code** +**How to lint and format to standard JS your code** ```bash - npm run format && npm run lint:fix + npm run lint:fix ``` ### Project pillars + Please consider our pillars before to start change the project - - Performance :racehorse: - - Security :bank: :cop: - - No runtime dependencies :white_check_mark: ( until now we don't have any exception to that) - - Easy to use :couple: - - Code quality :octocat: +- Performance :racehorse: +- Security :bank: :cop: +- No runtime dependencies :white_check_mark: (until now we don't have any exception to that) +- Easy to use :couple: +- Code quality :octocat: