.github templates

yegor256 · Feb 8, 2018 · 87b939a · 87b939a
1 parent b82d605
commit 87b939a
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,12 @@
+Make sure the title of the issue explains the problem you are having. Also, the description of the issue must clearly explain what is broken, not what you want us to implement. Go through this checklist and make sure you answer "YES" to all points:
+
+  - You have all pre-requisites listed in README.md installed
+  - You are sure that you are not reporting a duplicate (search all issues)
+  - You say "is broken" or "doesn't work" in the title
+  - You tell us what you are trying to do
+  - You explain the results you are getting
+  - You suggest an alternative result you would like to see
+
+This article will help you understand what we are looking for: http://www.yegor256.com/2014/11/24/principles-of-bug-tracking.html
+
+Thank you for your contribution!
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+Many thanks for your contribution, we truly appreciate it. We will appreciate it even more, if you make sure that you can say "YES" to each point in this short checklist:
+
+  - You made a small amount of changes (less than 100 lines, less than 10 files)
+  - You made changes related to only one bug (create separate PRs for separate problems)
+  - You are ready to defend your changes (there will be a code review)
+  - You don't touch what you don't understand
+  - You ran the build locally and it passed
+
+This article will help you understand what we are looking for: http://www.yegor256.com/2015/02/09/serious-code-reviewer.html
+
+Thank you for your contribution!