Commit | Line | Data |
---|---|---|
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> | |
4 | This repo use standard js style , please use it if you want to contribute <br> | |
5 | Take tasks from todo list, develop a new feature or fix a bug and do a pull request.<br> | |
6 | 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> | |
7 | ||
8 | Please 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 RA |
20 | ```bash |
21 | npm run standard | |
22 | ``` | |
cf9aa6c3 | 23 | |
590a5dd3 | 24 | <strong>How to lint and format (with prettier) your code</strong><br> |
cf9aa6c3 | 25 | |
557def79 RA |
26 | ```bash |
27 | npm run lint | |
cf9aa6c3 | 28 | ``` |