X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=fc6dfaed44b22c35cb5c6f8c06a87038e348abb2;hb=HEAD;hp=af859bf32855b3d4b3a55fc0902e0637f05d5fd7;hpb=186b35b6204e3f99db481c25f2d9521b41b27c8b;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af859bf3..fc6dfaed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +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 poolifier and link poolifier 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 do your PR on **master** branch. **How to run unit tests and coverage** ```bash - pnpm test && pnpm run coverage + pnpm test && pnpm coverage ``` **How to check if your new code is standard JS style** ```bash - pnpm run lint + pnpm lint ``` **How to format and lint to standard JS style your code** ```bash - pnpm run format && pnpm 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: +- 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 :couple: -- Code quality :octocat: +- Easy to use :white_check_mark: +- Code quality :white_check_mark: