Add repo vscode extensions recommendation (#99)
[poolifier.git] / CONTRIBUTING.md
CommitLineData
557def79
RA
1<h2 id="contribute">How to contribute</h2>
2
3[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)<br>
4This repo use standard js style , please use it if you want to contribute <br>
5Take tasks from todo list, develop a new feature or fix a bug and do a pull request.<br>
6Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project <br>
7
8Please ask your PR to be merged on <strong>master</strong> branch . <br>
9
10<strong>How to run tests</strong><br>
11
12<strong>Unit tests </strong> <br>
13
14```bash
15 npm run test
16```
17
557def79 18<strong> How to check if your new code is standard style </strong><br>
cf9aa6c3 19
557def79 20```bash
777b7824 21 npm run lint
557def79 22```
cf9aa6c3 23
590a5dd3 24<strong>How to lint and format (with prettier) your code</strong><br>
cf9aa6c3 25
557def79 26```bash
777b7824 27 npm run lint:fix
cf9aa6c3 28```