Skip to content

Commit 3049a65

Browse files
author
Achille
authored
improve issue templates (#883)
* improve issue templates * improve feature request template
1 parent 94daae2 commit 3049a65

File tree

2 files changed

+55
-10
lines changed

2 files changed

+55
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,59 @@ assignees: ''
88
---
99

1010
**Describe the bug**
11-
A clear and concise description of what the bug is.
11+
12+
> A clear and concise description of what the bug is.
1213
1314
**Kafka Version**
14-
What version(s) of Kafka are you testing against?
15+
16+
> * What version(s) of Kafka are you testing against?
17+
> * What version of kafka-go are you using?
1518
1619
**To Reproduce**
17-
Steps to reproduce the behavior. Bonus points for a code sample.
1820

19-
**Expected behavior**
20-
A clear and concise description of what you expected to happen.
21+
> Resources to reproduce the behavior:
22+
23+
```yaml
24+
---
25+
# docker-compose.yaml
26+
#
27+
# Adding a docker-compose file will help the maintainers setup the environment
28+
# to reproduce the issue.
29+
#
30+
# If one the docker-compose files available in the repository may be used,
31+
# mentioning it is also a useful alternative.
32+
...
33+
```
34+
35+
```go
36+
package main
37+
38+
import (
39+
"github.com/segmentio/kafka-go"
40+
)
41+
42+
func main() {
43+
// Adding a fully reproducible example will help maintainers provide
44+
// assistance to debug the issues.
45+
...
46+
}
47+
```
48+
49+
**Expected Behavior**
50+
51+
> A clear and concise description of what you expected to happen.
52+
53+
**Observed Behavior**
54+
55+
> A clear and concise description of the behavior you observed.
56+
57+
```
58+
Often times, pasting the logging output from a kafka.Reader or kafka.Writer will
59+
provide useful details to help maintainers investigate the issue and provide a
60+
fix. If possible, providing stack traces or CPU/memory profiles may also contain
61+
valuable information to understand the conditions that triggered the issue.
62+
```
63+
64+
**Additional Context**
2165

22-
**Additional context**
23-
Add any other context about the problem here.
66+
> Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ assignees: ''
77

88
---
99

10-
**Describe the solution you'd like**
11-
A clear and concise description of what you want to happen.
10+
**Describe the solution you would like**
11+
12+
> A clear and concise description of what you want to happen.
1213
1314
**Supporting documentation**
14-
Please provides links to relevant Kafka protocol docs and/or KIPs.
15+
16+
> Please provides links to relevant Kafka protocol docs and/or KIPs.

0 commit comments

Comments
 (0)