create better issue and PR templates (#4758)

4 files changed, 44 insertions, 22 deletions

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 2a524dde07..1bf8271010 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,27 +4,29 @@ about: Create a bug report to help us improve
 
 ---
 
-<!--- Verify first that your issue is not already reported on GitHub -->
-<!--- Also test if the latest release and devel branch are affected too -->
+<!---
+When creating a bug report please:
+- Verify first that your issue is not already reported on GitHub
+- Test if the latest release and master branch are affected too.
+- Provide a clear and concise description of what the bug is in "Bug report 
+  summary" section.
+- Try to provide as much information about your environment (OS distribution,
+  running in container, etc.) as possible to allow us reproduce this bug faster.
+- Write which component is affected. We group our components the same way our
+  code is structured so basically:
+  component name = dir in top level directory of repository
+- Describe how you found this bug and how we can reproduce it. Preferable with
+  a minimal test-case scenario. You can paste gist.github.com links for larger
+  files
+- Provide a clear and concise description of what you expected to happen.
+-->
 
 ##### Bug report summary
-<!-- A clear and concise description of what the bug is. -->
 
 ##### OS / Environment
-<!--- Provide all relevant information below, e.g. OS distribution, running in container, etc. -->
 
 ##### Component Name
-<!--- Write the short name of the module or plugin below -->
 
 ##### Steps To Reproduce
-<!--- Describe exactly how to reproduce the problem, using a minimal test-case -->
-
-<!--- Paste configuration you used between quotes below -->
-```yaml
-
-```
-
-<!--- HINT: You can paste gist.github.com links for larger files -->
 
 ##### Expected behavior
-<!-- A clear and concise description of what you expected to happen. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 7bba927405..b27ba2653f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,10 +4,13 @@ about: Suggest an idea for our project
 
 ---
 
-<!--- Verify first that your issue is not already reported on GitHub -->
+<!---
+When creating a feature request please:
+- Verify first that your issue is not already reported on GitHub
+- Explain new feature briefly in "Feature idea summary" section
+- Provide a clear and concise description of what you expect to happen.
+--->
 
 ##### Feature idea summary
-<!--- Explain new feature briefly below -->
 
 ##### Expected behavior
-<!-- A clear and concise description of what you expected to happen. -->
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md
new file mode 100644
index 0000000000..4fe94ad651
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_template.md
@@ -0,0 +1,10 @@
+<!---
+This is a generic issue template. We usually prefer contributors to use one
+of 3 other specific issue templates (bug report, feature request, question)
+to allow our automation classify those so you can get response faster.
+However if your issue doesn't fall into either one of those 3 categories
+use this generic template.
+--->
+
+#### Summary
+
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index e3fb9835ca..9bdf6f14e6 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -3,16 +3,23 @@ name: Question
 about: You just want to ask a question? Go on.
 ---
 
-<!--- Verify first that your question wasn't asked before on GitHub -->
+<!---
+When asking a new question please:
+- Verify first that your question wasn't asked before on GitHub. 
+  HINT: Use label "question" when searching for such issues.
+- Briefly explain what is the problem you are having
+- Try to provide as much information about your environment (OS distribution,
+  running in container, etc.) as possible to allow us reproduce this bug faster.
+- Write which component is affected. We group our components the same way our
+  code is structured so basically:
+    component name = dir in top level directory of repository
+- Provide a clear and concise description of what you expected to happen.
+-->
 
 ##### Question summary
-<!--- Briefly exmplain what is the problem you are having -->
 
 ##### OS / Environment
-<!--- Provide all relevant information below, e.g. OS distribution, running in container, etc. -->
 
 ##### Component Name
-<!--- Write the short name of the module or plugin below -->
 
 ##### Expected results
-<!-- A clear and concise description of what you expected to happen. -->