X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=25e44a18d6db95248bbbda29b082a5e392dbecef;hb=8f745a43a53ccc3111422eeb38399299a1c15525;hp=c66f6d94f8d89e633610cbbd4003ef4f1e260f41;hpb=5eff85b9bf1a04d19a9c896a79310a24ffd20317;p=poolifier.git
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c66f6d94..25e44a18 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,28 +1,36 @@
-
How to contribute
+## 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
+[![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 poolifier and link poolifier to your project
-Please ask your PR to be merged on master branch .
+Please do your PR on **master** branch.
-How to run tests
-
-Unit tests
+**How to run unit tests and coverage**
```bash
- npm run test
+ npm test && npm run coverage
```
- How to check if your new code is standard style
+**How to check if your new code is standard JS style**
```bash
- npm run standard:verbose && npm run ts-standard:verbose
+ npm run lint
```
-How to lint and format (with prettier) your code
+**How to format and lint to standard JS style your code**
```bash
- npm run lint-and-format
+ 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: