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