docs: add changelog entry
[poolifier.git] / CONTRIBUTING.md
CommitLineData
50aa7901 1## How to contribute
557def79 2
b5f498df 3This repo use standard js style, please use it if you want to contribute.
50aa7901 4[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
50aa7901 5Take tasks from todo list, develop a new feature or fix a bug and do a pull request.
b5f498df 6Another thing that you can do to contribute is to build something on top of poolifier and link poolifier to your project.
557def79 7
af5204ed 8Please do your PR on **master** branch.
557def79 9
78cea37e 10**How to run unit tests and coverage**
557def79
RA
11
12```bash
bb8ed27c 13 pnpm test && pnpm coverage
557def79
RA
14```
15
c1a41a06 16**How to check if your new code is standard JS style**
cf9aa6c3 17
557def79 18```bash
bb8ed27c 19 pnpm lint
557def79 20```
cf9aa6c3 21
c1a41a06 22**How to format and lint to standard JS style your code**
cf9aa6c3 23
557def79 24```bash
bb8ed27c 25 pnpm format && pnpm lint:fix
cf9aa6c3 26```
53ba2661
APA
27
28### Project pillars
b53f9ec9 29
53ba2661
APA
30Please consider our pillars before to start change the project
31
b5f498df
JB
32- Performance :white_check_mark:
33- Security :white_check_mark:
d2c42d44 34- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
b5f498df
JB
35- Easy to use :white_check_mark:
36- Code quality :white_check_mark: