X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=e6babf4fea4a24343f5f926f4e023937bd6f4cd6;hb=16671b07d958f4d61f4d982db2cb139ea665886d;hp=c148e5a0867fd3172db2b1b2048b1d0409dda96c;hpb=b53f9ec9ada29530084186e5b1bd9b578be76a92;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c148e5a0..e6babf4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,28 +3,26 @@ [![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard) This repo use standard js style, please use it if you want to contribute Take tasks from todo list, develop a new feature or fix a bug and do a pull request. -Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project +Another thing that you can do to contribute is to build something on top of poolifier and link poolifier to your project -Please ask your PR to be merged on **master** branch. +Please do your PR on **master** branch. -**How to run tests** - -**Unit tests** +**How to run unit tests and coverage** ```bash - npm run test + pnpm test && pnpm coverage ``` -**How to check if your new code is standard style** +**How to check if your new code is standard JS style** ```bash - npm run lint + pnpm lint ``` -**How to lint and format (with prettier) your code** +**How to format and lint to standard JS style your code** ```bash - npm run format && npm run lint:fix + pnpm format && pnpm lint:fix ``` ### Project pillars