From 8963343195462d4b46123f517404f585dbd46f4a Mon Sep 17 00:00:00 2001 From: Morteza Ziyae Date: Thu, 4 Jul 2019 11:06:24 +0430 Subject: [PATCH] update readme, add contributing guide --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 3 ++- 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f096672 --- /dev/null +++ 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 index 0ac1fb6..e0c30dc 100644 --- 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).