[poolifier.git] / CONTRIBUTING.md

## How to contribute

This repo use standard js style, please use it if you want to contribute.  
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)  
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 poolifier and link poolifier to your project.

Please do your PR on **master** branch.

**How to run unit tests and coverage**

```bash
  pnpm test && pnpm coverage
```

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

```bash
  pnpm lint
```

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

```bash
  pnpm format && pnpm lint:fix
```

### Project pillars

Please consider our pillars before to start change the project

- Performance :white_check_mark:
- Security :white_check_mark:
- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
- Easy to use :white_check_mark:
- Code quality :white_check_mark:
Commit	Line	Data
	1	## How to contribute
	2
	3	This repo use standard js style, please use it if you want to contribute.
	4	[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
	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 poolifier and link poolifier to your project.
	7
	8	Please do your PR on master branch.
	9
	10	How to run unit tests and coverage
	11
	12	```bash
	13	pnpm test && pnpm coverage
	14	```
	15
	16	How to check if your new code is standard JS style
	17
	18	```bash
	19	pnpm lint
	20	```
	21
	22	How to format and lint to standard JS style your code
	23
	24	```bash
	25	pnpm format && pnpm lint:fix
	26	```
	27
	28	### Project pillars
	29
	30	Please consider our pillars before to start change the project
	31
	32	- Performance :white_check_mark:
	33	- Security :white_check_mark:
	34	- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
	35	- Easy to use :white_check_mark:
	36	- Code quality :white_check_mark: