CHANGELOG.md: 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
50aa7901 10**How to run tests**
557def79 11
515e5da7 12**Unit tests and Coverage**
557def79
RA
13
14```bash
15 npm run test
515e5da7 16 npm run coverage
557def79
RA
17```
18
50aa7901 19**How to check if your new code is standard style**
cf9aa6c3 20
557def79 21```bash
777b7824 22 npm run lint
557def79 23```
cf9aa6c3 24
50aa7901 25**How to lint and format (with prettier) your code**
cf9aa6c3 26
557def79 27```bash
50aa7901 28 npm run format && npm run lint:fix
cf9aa6c3 29```
53ba2661
APA
30
31### Project pillars
b53f9ec9 32
53ba2661
APA
33Please consider our pillars before to start change the project
34
b53f9ec9
S
35- Performance :racehorse:
36- Security :bank: :cop:
37- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
38- Easy to use :couple:
39- Code quality :octocat: