CONTRIBUTING.md

   1 ## How to contribute
   2
   3 [![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
   4 This repo use standard js style, please use it if you want to contribute
   5 Take tasks from todo list, develop a new feature or fix a bug and do a pull request.
   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
   7
   8 Please ask your PR to be merged on **master** branch.
   9
  10 **How to run tests**
  11
  12 **Unit tests**
  13
  14 ```bash
  15   npm run test
  16 ```
  17
  18 **How to check if your new code is standard style**
  19
  20 ```bash
  21   npm run lint
  22 ```
  23
  24 **How to lint and format (with prettier) your code**
  25
  26 ```bash
  27   npm run format && npm run lint:fix
  28 ```
  29
  30 ### Project pillars
  31 Please consider our pillars before to start change the project
  32
  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: