X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=CONTRIBUTING.md;h=d41ad6e0d70de479a3ff0002f000d89218f840af;hb=cda5cc74c77bdfc37b220ef19637876e221b5061;hp=c57e879c470025a798698ca1944e03b54d75b5ae;hpb=777b7824df53fc7a599e6d7bc2f1f917f6193f0d;p=poolifier.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c57e879c..d41ad6e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,28 @@ -

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** ```bash npm run test ``` - 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 ```