Update CONTRIBUTING.md

[poolifier.git] / CONTRIBUTING.md

## How to contribute

[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)  
This repo use standard js style, please use it if you want to contribute  
Take tasks from todo list, develop a new feature or fix a bug and do a pull request.  
Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project

Please ask your PR to be merged on **master** branch.

**How to run tests**

**Unit tests**

```bash
  npm run test
```

**How to check if your new code is standard style**

```bash
  npm run lint
```

**How to lint and format (with prettier) your code**

```bash
  npm run format && npm run lint:fix
```

### Project pillars
Please consider our pillars before to start change the project

  - Performance :racehorse:
  - Security :bank: :cop:
  - No runtime dependencies :white_check_mark: ( until now we don't have any exception to that)
  - Easy to use :couple:
  - Code quality :octocat: