X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=af859bf32855b3d4b3a55fc0902e0637f05d5fd7;hb=refs%2Ftags%2Fv2.4.2;hp=d5e6430f05ef0e323dc467a56548bd750ccf6a6a;hpb=515e5da7461f84786a9b6acf859cf65a083e2f4c;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5e6430f..af859bf3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,29 +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 and Coverage** +**How to run unit tests and coverage** ```bash - npm run test - npm run coverage + pnpm test && pnpm run 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 run 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 run format && pnpm run lint:fix ``` ### Project pillars