-<h2 id="contribute">How to contribute</h2>
+## How to contribute
-[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)<br>
-This repo use standard js style , please use it if you want to contribute <br>
-Take tasks from todo list, develop a new feature or fix a bug and do a pull request.<br>
-Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project <br>
+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)
+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 ask your PR to be merged on <strong>master</strong> branch . <br>
+Please do your PR on **master** branch.
-<strong>How to run tests</strong><br>
-
-<strong>Unit tests </strong> <br>
+**How to run unit tests and coverage**
```bash
- npm run test
+ pnpm test && pnpm coverage
```
-<strong> How to check if your new code is standard style </strong><br>
+**How to check if your new code is standard JS style**
```bash
- npm run standard:verbose && npm run ts-standard:verbose
+ pnpm lint
```
-<strong>How to lint and format (with prettier) your code</strong><br>
+**How to format and lint to standard JS style your code**
```bash
- npm run lint-and-format
+ pnpm format && pnpm lint:fix
```
+
+### Project pillars
+
+Please consider our pillars before to start change the project
+
+- 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: