X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=CONTRIBUTING.md;h=d5e6430f05ef0e323dc467a56548bd750ccf6a6a;hb=3ffada528b1ca9f062534bf09dd9772d1b2d4673;hp=bf5bc794ee8b3259738ad6b152667180fdb098a3;hpb=1305149bf501a445ee07051a089830f54b6c01b5;p=poolifier.git
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bf5bc794..d5e6430f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,26 +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 standard
+ npm run lint
```
-How to lint your code
+
+**How to lint and format (with prettier) 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: