create better issue and PR templates (#4758)
Paweł Krupa committed
Nov 27, 2018 at 11:08 UTC
cc5af8095f125a6ef1f25b4302b4d448c307a6a1
5 files changed
+57
-32
.github/ISSUE_TEMPLATE/bug_report.md
+16
-14
@@ -4,27 +4,29 @@ about: Create a bug report to help us improve
4
5
---
6
7
-<!--- Verify first that your issue is not already reported on GitHub -->
8
-<!--- Also test if the latest release and devel branch are affected too -->
7
+<!---
8
+When creating a bug report please:
9
+- Verify first that your issue is not already reported on GitHub
10
+- Test if the latest release and master branch are affected too.
11
+- Provide a clear and concise description of what the bug is in "Bug report
12
+ summary" section.
13
+- Try to provide as much information about your environment (OS distribution,
14
+ running in container, etc.) as possible to allow us reproduce this bug faster.
15
+- Write which component is affected. We group our components the same way our
16
+ code is structured so basically:
17
+ component name = dir in top level directory of repository
18
+- Describe how you found this bug and how we can reproduce it. Preferable with
19
+ a minimal test-case scenario. You can paste gist.github.com links for larger
20
+ files
21
+- Provide a clear and concise description of what you expected to happen.
22
+-->
23
24
##### Bug report summary
11
-<!-- A clear and concise description of what the bug is. -->
25
26
##### OS / Environment
14
-<!--- Provide all relevant information below, e.g. OS distribution, running in container, etc. -->
27
28
##### Component Name
17
-<!--- Write the short name of the module or plugin below -->
29
30
##### Steps To Reproduce
20
-<!--- Describe exactly how to reproduce the problem, using a minimal test-case -->
21
-
22
-<!--- Paste configuration you used between quotes below -->
23
-```yaml
24
-
25
-```
26
-
27
-<!--- HINT: You can paste gist.github.com links for larger files -->
31
32
##### Expected behavior
30
-<!-- A clear and concise description of what you expected to happen. -->
.github/ISSUE_TEMPLATE/feature_request.md
+6
-3
@@ -4,10 +4,13 @@ about: Suggest an idea for our project
4
5
---
6
7
-<!--- Verify first that your issue is not already reported on GitHub -->
7
+<!---
8
+When creating a feature request please:
9
+- Verify first that your issue is not already reported on GitHub
10
+- Explain new feature briefly in "Feature idea summary" section
11
+- Provide a clear and concise description of what you expect to happen.
12
+--->
13
14
##### Feature idea summary
10
-<!--- Explain new feature briefly below -->
15
16
##### Expected behavior
13
-<!-- A clear and concise description of what you expected to happen. -->
.github/ISSUE_TEMPLATE/issue_template.md
new
+10
@@ -0,0 +1,10 @@
1
+<!---
2
+This is a generic issue template. We usually prefer contributors to use one
3
+of 3 other specific issue templates (bug report, feature request, question)
4
+to allow our automation classify those so you can get response faster.
5
+However if your issue doesn't fall into either one of those 3 categories
6
+use this generic template.
7
+--->
8
+
9
+#### Summary
10
+
.github/ISSUE_TEMPLATE/question.md
+12
-5
@@ -3,16 +3,23 @@ name: Question
3
about: You just want to ask a question? Go on.
4
---
5
6
-<!--- Verify first that your question wasn't asked before on GitHub -->
6
+<!---
7
+When asking a new question please:
8
+- Verify first that your question wasn't asked before on GitHub.
9
+ HINT: Use label "question" when searching for such issues.
10
+- Briefly explain what is the problem you are having
11
+- Try to provide as much information about your environment (OS distribution,
12
+ running in container, etc.) as possible to allow us reproduce this bug faster.
13
+- Write which component is affected. We group our components the same way our
14
+ code is structured so basically:
15
+ component name = dir in top level directory of repository
16
+- Provide a clear and concise description of what you expected to happen.
17
+-->
18
19
##### Question summary
9
-<!--- Briefly exmplain what is the problem you are having -->
20
21
##### OS / Environment
12
-<!--- Provide all relevant information below, e.g. OS distribution, running in container, etc. -->
22
23
##### Component Name
15
-<!--- Write the short name of the module or plugin below -->
24
25
##### Expected results
18
-<!-- A clear and concise description of what you expected to happen. -->
.github/PULL_REQUEST_TEMPLATE.md
+13
-10
@@ -1,16 +1,19 @@
1
-##### Summary
2
-<!--- Describe the change below, including rationale and design decisions -->
1
+<!--
2
+Describe the change in summary section, including rationale and degin decisions.
3
+Include "Fixes #nnn" if you are fixing an existing issue.
4
+
5
+In "Component Name" section write which component is changed in this PR. This
6
+will help us review your PR quicker.
7
4
-<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
8
+If you have more information you want to add, write them in "Additional
9
+Information" section. This is usually used to help others understand your
10
+motivation behind this change. A step-by-step reproduction of the problem is
11
+helpful if there is no related issue.
12
+-->
13
+
14
+##### Summary
15
16
##### Component Name
7
-<!--- Write the short name of the module or plugin below -->
17
18
##### Additional Information
10
-<!--- Include additional information to help people understand the change here -->
11
-<!--- A step-by-step reproduction of the problem is helpful if there is no related issue -->
12
-
13
-<!--- Paste log output below, e.g. before and after your change -->
14
-```paste below
19
16
-```