X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=CONTRIBUTING.md;h=25e44a18d6db95248bbbda29b082a5e392dbecef;hb=6280f2af8a9a129e3986cc4bffb900a8b8507ba2;hp=bf5bc794ee8b3259738ad6b152667180fdb098a3;hpb=557def798895e719884a335486f8d311fe06f59c;p=poolifier.git
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bf5bc794..25e44a18 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,26 +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 JS style**
- How to check if your new code is standard style
```bash
- npm run standard
+ npm run lint
```
-How to lint your code
+
+**How to format and lint to standard JS style your code**
+
```bash
- npm run lint
-```
\ No newline at end of file
+ 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: