docs: add pull request template

changkun · Jan 31, 2019 · 34ee80e · 34ee80e
1 parent 1b3d235
commit 34ee80e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+resolve #issue_id
+
+## Details
+
+Please briefly describe the motivation of this pull request, and which problem is solved in this PR.
+
+## Changes
+
+- Fixes ...
+- Adds ...
+- Resolves ...
+
+## References
+
+related issues:
+
+- #issue_id
+- #issue_id
diff --git a/README.md b/README.md
@@ -21,6 +21,12 @@ without any changes.
 
 Read more details in [docs](./docs/README.md)
 
+## Contributing
+
+Easiest way to contribute is to provide feedback! 
+We would love to hear what you like and what you think is missing.
+PRs are welcome. Please follow the given PR template before you send your pull request.
+
 ## Development
 
 ```