X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=fc6dfaed44b22c35cb5c6f8c06a87038e348abb2;hb=HEAD;hp=50957aa3078a91e57448add6643a600096b30fcc;hpb=53ba26617bbaf5363baf7f8a8b31a52465ff4ade;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50957aa3..fc6dfaed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,36 @@ ## How to contribute +This repo use standard js style, please use it if you want to contribute. [![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 + 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 :white_check_mark: +- Security :white_check_mark: +- No runtime dependencies :white_check_mark: (until now we don't have any exception to that) +- Easy to use :white_check_mark: +- Code quality :white_check_mark: