From e7a567db1d23d7724ed3367eb0cf7a3b0af0d79e Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Fri, 5 Feb 2021 16:48:09 +0100 Subject: [PATCH] Provide bug report & feature request as issue form (#1483) * Create feature_request.yml * Delete Feature_request.md * Create bug_report.yml * Delete Bug_report.md --- .github/ISSUE_TEMPLATE/Bug_report.md | 38 ---------- .github/ISSUE_TEMPLATE/Feature_request.md | 17 ----- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 17 +++++ 4 files changed, 101 insertions(+), 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 8c3db2590..000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Report a bug -about: Create a report to help us improve -labels: bug ---- - -A clear and concise description of what the bug is. - -## Expected Behavior - - -## Actual Behavior - - -## Steps to Reproduce the Problem - - 1. - 2. - 3. - -## Configuration -Provide insights in the configuration that you are using: -- Configured scraping schedule: - -
-Used scraping configuration - -```yaml -# Add your scraping configuration here -``` - -
- -## Specifications - - - Version: - - Platform: - - Subsystem: diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index 615610ad2..000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -A clear and concise description of what you want to happen. - -### Specification - -- [ ] Demand #1 - -### API Specification -- **Verb:** GET -- **Path:** api/v1/ -- **Reponse Codes:** - - To be defined diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..d4239024c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,84 @@ +name: Report a bug 🐛 +about: Create a report to help us improve +labels: "bug" +assignees: tomkerkhove +issue_body: true +inputs: +- type: textarea + attributes: + label: Report + description: "What bug have you encountered?" + placeholder: "A clear and concise description of what the bug is." +- type: textarea + attributes: + label: Expected Behavior + description: What did you expect to happen? + required: true + placeholder: What did you expect to happen? +- type: textarea + attributes: + label: Actual Behavior + description: Also tell us, what did you see is happen? + required: true + placeholder: Tell us what you see that is happening +- type: textarea + attributes: + label: Steps to Reproduce the Problem + description: "How can we reproduce this bug? Please walk us through it step by step." + value: | + 1. + 2. + 3. + ... + required: true +- type: dropdown + attributes: + label: Component + description: What Promitor agent are you having issues with? + required: true + choices: + - Scraper + - Resource Discovery +- type: input + attributes: + label: Version + description: What version are you running? + required: true +- type: textarea + attributes: + label: Configuration + description: "Provide insights in the configuration that you are using, if you can share them" + value: | + Configuration: + + ```yaml + # Add your scraping configuration here + ``` + required: false +- type: textarea + attributes: + label: Logs + description: "Provide logs of our component, if you can share them" + value: | + ```yaml + example + ``` + required: false +- type: dropdown + attributes: + label: Platform + description: Where is your cluster running? + required: false + choices: + - Alibaba Cloud + - Amazon Web Services + - Google Cloud + - Microsoft Azure + - Red Hat OpenShift + - Other +- type: input + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + required: false + placeholder: ex. email@example.com diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..6ace9b4eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,17 @@ +name: Feature request 🧭 +about: Suggest an idea for this project +labels: "feature-request" +assignees: tomkerkhove +issue_body: true +inputs: +- type: textarea + attributes: + label: Proposal + description: "What would you like to have as a feature" + placeholder: "A clear and concise description of what you want to happen." +- type: input + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + required: false + placeholder: ex. email@example.com