X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=d5e6430f05ef0e323dc467a56548bd750ccf6a6a;hb=143f3ca22ba9859afed14f6a137d676a4f2cc0a0;hp=c57e879c470025a798698ca1944e03b54d75b5ae;hpb=777b7824df53fc7a599e6d7bc2f1f917f6193f0d;p=poolifier.git
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c57e879c..d5e6430f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,28 +1,39 @@
-
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 ring-election and link ring-election to your project
-Please ask your PR to be merged on master branch .
+Please ask your PR to be merged on **master** branch.
-How to run tests
+**How to run tests**
-Unit tests
+**Unit tests and Coverage**
```bash
npm run test
+ npm run coverage
```
- How to check if your new code is standard style
+**How to check if your new code is standard style**
```bash
npm run lint
```
-How to lint and format (with prettier) your code
+**How to lint and format (with prettier) your code**
```bash
- npm run lint:fix
+ 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: