fix(CONTRIBUTING.md): moved to root dir
authorRifa Achrinza <25147899+achrinza@users.noreply.github.com>
Thu, 23 Jan 2020 07:06:09 +0000 (15:06 +0800)
committerRifa Achrinza <25147899+achrinza@users.noreply.github.com>
Thu, 23 Jan 2020 07:06:09 +0000 (15:06 +0800)
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..bf5bc79
--- /dev/null
@@ -0,0 +1,26 @@
+<h2 id="contribute">How to contribute</h2>
+
+[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)<br>
+This repo use standard js style , please use it if you want to contribute <br>
+Take tasks from todo list, develop a new feature or fix a bug and do a pull request.<br>
+Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project <br>
+
+Please ask your PR to be merged on <strong>master</strong> branch . <br>
+
+<strong>How to run tests</strong><br>
+
+<strong>Unit tests </strong> <br>
+
+```bash
+  npm run test
+```
+
+
+<strong> How to check if your new code is standard style </strong><br>
+```bash
+  npm run standard
+```
+<strong>How to lint your code</strong><br>
+```bash
+  npm run lint
+```
\ No newline at end of file