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