docs: add contribute guide

plantain-00 · Aug 1, 2020 · 868c03d · 868c03d
1 parent 444e938
commit 868c03d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# How to contribute
+
+## install dev dependencies
+
+`yarn`
+
+## build
+
++ production build: `yarn build`
++ development build: `yarn dev`
++ watch mode: `yarn watch`
+
+## serve demo
+
+Use a static files http server, for example: `http-server -p 8080`
+
+## lint code
+
+`yarn lint`