From e3ad1e2483b412169ab633fa8bf4e590a45d3ea4 Mon Sep 17 00:00:00 2001 From: Tommy Brunn Date: Tue, 21 Apr 2020 09:13:13 +0200 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++ .npmignore | 1 + 3 files changed, 55 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..80465a3e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Please provide either a link to a: + +1. [failing test in a KafkaJS fork](https://github.com/tulios/kafkajs/blob/2faef0719eeba50759eccc2b7d8800dbe63803f3/src/consumer/__tests__/consumeMessages.spec.js#L52-L97) +2. [repository with an example project reproducing the issue](https://github.com/tulios/kafkajs/blob/master/examples/consumer.js) + +If none of the above are possible to provide, please write down the exact steps to reproduce the behavior: +1. Run a producer that continuously produces messages to a topic +2. Run a consumer that subscribes to that topic and logs each topic offset +3. After the consumer has consumed 100 messages, it... + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Observed behavior** +A clear and concise description of what *did* happen. Please include any relevant logs [with the log level set to debug](https://kafka.js.org/docs/configuration#logging). + +**Environment:** + - OS: [e.g. Mac OS 10.15.3] + - KafkaJS version [e.g. 1.12.0] + - Kafka version [e.g. 2.3.1] + - NodeJS version [e.g. 10.13.0] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..ce6bdf23e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. Please include links to other clients' solutions and/or KIPs for Kafka features if applicable. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.npmignore b/.npmignore index 3ae616087..18b61f90b 100644 --- a/.npmignore +++ b/.npmignore @@ -31,3 +31,4 @@ logo *.java types/tests.ts types/tsconfig.json +.github/