improve issue templates (segmentio#883)

* improve issue templates * improve feature request template
jackjie2016 · Apr 11, 2022 · 3049a65 · 3049a65
1 parent 94daae2
commit 3049a65
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,16 +8,59 @@ assignees: ''
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+
+> A clear and concise description of what the bug is.
 
 **Kafka Version**
-What version(s) of Kafka are you testing against?
+
+> * What version(s) of Kafka are you testing against?
+> * What version of kafka-go are you using?
 
 **To Reproduce**
-Steps to reproduce the behavior.  Bonus points for a code sample.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+> Resources to reproduce the behavior:
+
+```yaml
+---
+# docker-compose.yaml
+#
+# Adding a docker-compose file will help the maintainers setup the environment
+# to reproduce the issue.
+#
+# If one the docker-compose files available in the repository may be used,
+# mentioning it is also a useful alternative.
+...
+```
+
+```go
+package main
+
+import (
+    "github.com/segmentio/kafka-go"
+)
+
+func main() {
+    // Adding a fully reproducible example will help maintainers provide
+    // assistance to debug the issues.
+    ...
+}
+```
+
+**Expected Behavior**
+
+> A clear and concise description of what you expected to happen.
+
+**Observed Behavior**
+
+> A clear and concise description of the behavior you observed.
+
+```
+Often times, pasting the logging output from a kafka.Reader or kafka.Writer will
+provide useful details to help maintainers investigate the issue and provide a
+fix. If possible, providing stack traces or CPU/memory profiles may also contain
+valuable information to understand the conditions that triggered the issue.
+```
+
+**Additional Context**
 
-**Additional context**
-Add any other context about the problem here.
+> Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,8 +7,10 @@ assignees: ''
 
 ---
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you would like**
+
+> A clear and concise description of what you want to happen.
 
 **Supporting documentation**
-Please provides links to relevant Kafka protocol docs and/or KIPs.
+
+> Please provides links to relevant Kafka protocol docs and/or KIPs.