Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1.03 KB

How to contribute

This repo use standard js style, please use it if you want to contribute.
JavaScript Style Guide
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.

Please do your PR on master branch.

How to run unit tests and coverage

  pnpm test && pnpm coverage

How to check if your new code is standard JS style

  pnpm lint

How to format and lint to standard JS style your code

  pnpm format && pnpm lint:fix

Project pillars

Please consider our pillars before to start change the project

  • Performance ✅
  • Security ✅
  • No runtime dependencies ✅ (until now we don't have any exception to that)
  • Easy to use ✅
  • Code quality ✅