From 78c7b638bae8477426d63446c68edfec918559a7 Mon Sep 17 00:00:00 2001 From: Dominic Evans <8060970+dnwe@users.noreply.github.com> Date: Thu, 24 Aug 2023 23:30:32 +0100 Subject: [PATCH] chore(gh): add new style issue templates Signed-off-by: Dominic Evans --- .github/ISSUE_TEMPLATE.md | 30 --------------- .github/ISSUE_TEMPLATE/bug_report.md | 46 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++ 3 files changed, 62 insertions(+), 30 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index df9ea04bd..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,30 +0,0 @@ -##### Versions - -*Please specify real version numbers or git SHAs, not just "Latest" since that changes fairly regularly.* - -| Sarama | Kafka | Go | -|--------|-------|----| -| | | | - -##### Configuration - -What configuration values are you using for Sarama and Kafka? -``` go -``` - -##### Logs - -When filing an issue please provide logs from Sarama and Kafka if at all -possible. You can set `sarama.Logger` to a `log.Logger` to capture Sarama debug -output. - -
logs: CLICK ME -

- -``` -``` - -

-
- -##### Problem Description diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..f08437af7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug report +about: Report an issue that you've found +title: '' +labels: '' +assignees: '' + +--- + +##### Description + +<-- A clear and concise description of what the bug is and how to reproduce it. --> + +##### Versions + +<-- Please specify real version numbers or git SHAs, not just "Latest" since that changes fairly regularly. --> + +| Sarama | Kafka | Go | +| ------ | ----- | --- | +| | | | + +##### Configuration + +<-- What configuration values are you using for Sarama and Kafka? --> + +```go + +``` + +##### Logs + +<-- If applicable, add logs from Sarama and/or Kafka to help explain your problem. +You can set `sarama.Logger` to a `log.Logger` to capture Sarama debug output. --> + +
logs: CLICK ME +

+ +``` +``` + +

+
+ +##### Additional Context + +<-- Add any other context about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..74280bddb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "" +labels: "" +assignees: "" +--- + +#### Description + +<-- A clear and concise description of what the missing capability is, why it's a problem and what you want to happen --> + +#### Additional context + +<-- Add any other context or links to existing implementations of the feature in other Kafka clients --> +<-- Please link to the relevant KIP from https://cwiki.apache.org/confluence/display/KAFKA/Kafka+Improvement+Proposals if appropriate -->