update readme, add contributing guide

mort3za · Jul 4, 2019 · 8963343 · 8963343
1 parent 14c3b31
commit 8963343
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# How to contribute to Ludo
+
+## You want to report a bug?
+Preferably add a screenshot.  
+Describe steps to reproduce the bug.  
+English, please.  
+
+## You want to send a pull request?
+Make sure there is a relative issue and send a comment there to acquire the task if it's not assigned to others or create a new one.  
+Write a descriptive commit message and try to squash commits.  
+There should be no error in terminal (e.g. TypeScript errors).  
+Keep coding style and quality.  
diff --git a/README.md b/README.md
@@ -16,4 +16,5 @@ You can [play here](https://mort3za.github.io/ludo)
 
 ## Contribution
 
-There are some tasks in issues page if you are interested or just open your own issue (in English please). Any helps is greatly appreciated.
+There are some tasks in issues page if you are interested or just open your own issue (in English please). Any helps is greatly appreciated.  
+Please read [Contributing Guideline](CONTRIBUTING.md).