From 011b98b3e052d59c396adeb6895b9298ff713bcf Mon Sep 17 00:00:00 2001 From: Andy Pan Date: Sun, 27 Nov 2022 02:16:08 +0800 Subject: [PATCH] chore: update the issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 105 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 32 ------ .github/ISSUE_TEMPLATE/feature-request.yaml | 60 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/question.yaml | 26 +++++ .github/ISSUE_TEMPLATE/question_inquiry.md | 11 -- 6 files changed, 191 insertions(+), 63 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.yaml delete mode 100644 .github/ISSUE_TEMPLATE/question_inquiry.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000..96ecc98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,105 @@ +name: Bug Report +description: Oops!..., it's a bug. +title: "[Bug]: " +labels: ["bug"] +assignees: + - panjf2000 +body: + - type: markdown + id: tips + attributes: + value: | + ## Before you go any further + - Please read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally. + - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants). + - type: checkboxes + id: checklist + attributes: + label: Actions I've taken before I'm here + description: Make sure you have tried the following ways but still the problem has not been solved. + options: + - label: I've thoroughly read the documentations on this issue but still have no clue. + required: true + - label: I've searched the current list of Github issues but didn't find any duplicate issues that have been solved. + required: true + - label: I've searched the internet with this issue, but haven't found anything helpful. + required: true + validations: + required: true + - type: textarea + id: bug-report + attributes: + label: What happened? + description: Describe (and illustrate) the bug that you encountered precisely. + placeholder: Please describe what happened and how it happened, the more details you provide, the faster the bug gets fixed. + validations: + required: true + - type: dropdown + id: major-version + attributes: + label: Major version of ants + description: What major version of ants are you running? + options: + - v2 + - v1 + validations: + required: true + - type: input + id: specific-version + attributes: + label: Specific version of ants + description: What's the specific version of ants? + placeholder: "For example: v2.6.0" + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating system + multiple: true + options: + - Linux + - macOS + - Windows + - BSD + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. + render: shell + validations: + required: true + - type: textarea + id: code + attributes: + label: Code snippets (optional) + description: Helpful code snippets can really speed up the process of locating root cause and fixing the bug. + render: go + - type: textarea + id: how-to-reproduce + attributes: + label: How to Reproduce + description: Steps to reproduce the result. + placeholder: Tell us step by step how we can replicate this bug and what we should see in the end. + value: | + Steps to reproduce the behavior: + 1. Go to '....' + 2. Click on '....' + 3. Do '....' + 4. See '....' + validations: + required: true + - type: dropdown + id: bug-in-latest-code + attributes: + label: Does this issue reproduce with the latest release? + description: Whether this bug still exists in the latest version. + options: + - It can reproduce with the latest release + - It gets fixed in the latest release + - I haven't verified it with the latest release + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 287fe92..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: panjf2000 - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Error messages/Trace logs** -If applicable, add some logs to help explain your problem. - -**System info (please complete the following information):** - - OS: [e.g. linux, macOS] - - Go Version: [e.g. 1.12] - - ants version: [e.g. v2.2.2] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 0000000..eadc2d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,60 @@ +name: Feature Request +description: Propose an idea to make ants even better. +title: "[Feature]: " +labels: ["proposal", "enhancement"] +assignees: + - panjf2000 +body: + - type: markdown + id: tips + attributes: + value: | + ## Before you go any further + - Please read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally. + - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants). + - type: textarea + id: feature-request + attributes: + label: Description of new feature + description: Make a concise but clear description about this new feature. + placeholder: Describe this new feature with critical details. + validations: + required: true + - type: textarea + id: feature-scenario + attributes: + label: Scenarios for new feature + description: Explain why you need this feature and what scenarios can benefit from it. + placeholder: Please try to convince us that this new feature makes sense, also it will improve ants. + validations: + required: true + - type: dropdown + id: breaking-changes + attributes: + label: Breaking changes or not? + description: Is this new feature going to break the backward compatibility of the existing APIs? + options: + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: code + attributes: + label: Code snippets (optional) + description: Illustrate this new feature with source code, what it looks like in code. + render: go + - type: textarea + id: feature-alternative + attributes: + label: Alternatives for new feature + description: Alternatives in your mind in case that the feature can't be done for some reasons. + placeholder: A concise but clear description of any alternative solutions or features you had in mind. + value: None. + - type: textarea + id: additional-context + attributes: + label: Additional context (optional) + description: Any additional context about this new feature we should know. + placeholder: What else should we know before we start discussing this new feature? + value: None. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 48a01f6..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: proposal -assignees: panjf2000 - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000..ed605e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,26 @@ +name: Question +description: Ask questions about ants. +title: "[Question]: " +labels: ["question", "help wanted"] +body: + - type: markdown + id: tips + attributes: + value: | + ## Before you go any further + - Please read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) ( Chinese translation: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)) before you file an issue formally. + - Keep in mind that there is always welcome to ask questions on [Gitter](https://gitter.im/ants-pool/ants). + - type: textarea + id: question + attributes: + label: Questions with details + description: What do you want to know? + placeholder: Describe your question with critical details here. + validations: + required: true + - type: textarea + id: code + attributes: + label: Code snippets (optional) + description: Illustrate your question with source code if needed. + render: go diff --git a/.github/ISSUE_TEMPLATE/question_inquiry.md b/.github/ISSUE_TEMPLATE/question_inquiry.md deleted file mode 100644 index f59bb8f..0000000 --- a/.github/ISSUE_TEMPLATE/question_inquiry.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Question inquiry -about: Ask a question about this project -title: '' -labels: question, help wanted -assignees: panjf2000 - ---- - -**What is your question about ants?** -Please describe your question meticulously.