[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 unit tests and coverage**

```bash
  npm test
  npm run coverage
```

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

```bash
  npm run lint
```

**How to lint and format to standard JS your code**

```bash
  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:
Commit	Line	Data
	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 unit tests and coverage
	11
	12	```bash
	13	npm test
	14	npm run coverage
	15	```
	16
	17	How to check if your new code is standard style
	18
	19	```bash
	20	npm run lint
	21	```
	22
	23	How to lint and format to standard JS your code
	24
	25	```bash
	26	npm run lint:fix
	27	```
	28
	29	### Project pillars
	30
	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: