From 59f20c10345e27d4060365f7c5a38ae9db0ecaa8 Mon Sep 17 00:00:00 2001 From: Zakhar Bessarab Date: Wed, 4 Jan 2023 17:34:19 +0400 Subject: [PATCH] github: use github templates for filling in feature requests or bug reports (#3587) github: use github templates for filling in feature requests or bug reports --- .github/ISSUE_TEMPLATE/bug_report.md | 46 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 87 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/configuration.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 44 +++++++++++ 5 files changed, 136 insertions(+), 66 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/configuration.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md 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 39b230b35..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -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. -It would be great to [upgrade](https://docs.victoriametrics.com/#how-to-upgrade) -to [the latest available release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) -and verify whether the bug is reproducible there. -It's also recommended to read the [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html). - -**To Reproduce** -Steps to reproduce the behavior. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Logs** -Check if any warnings or errors were logged by VictoriaMetrics components -or components in communication with VictoriaMetrics (e.g. Prometheus, Grafana). - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -For VictoriaMetrics health-state issues please provide full-length screenshots -of Grafana dashboards if possible: -* [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics/) -* [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) - -See how to setup monitoring here: -* [monitoring for single-node VictoriaMetrics](https://docs.victoriametrics.com/#monitoring) -* [monitoring for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#monitoring) - -**Version** -The line returned when passing `--version` command line flag to the binary. For example: -``` -$ ./victoria-metrics-prod --version -victoria-metrics-20190730-121249-heads-single-node-0-g671d9e55 -``` - -**Used command-line flags** -Please provide the command-line flags used for running VictoriaMetrics and its components. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..8fc03f44d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: Bug report +description: Create a report to help us improve +labels: [bug] +body: + - type: markdown + attributes: + value: | + Before filling a bug report it would be great to [upgrade](https://docs.victoriametrics.com/#how-to-upgrade) + to [the latest available release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) + and verify whether the bug is reproducible there. + It's also recommended to read the [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html) first. + - type: textarea + id: describe-the-bug + attributes: + label: Describe the bug + render: plain text + description: | + A clear and concise description of what the bug is. + placeholder: | + When I do `A` VictoriaMetrics does `B`. I expect it to do `C`. + validations: + required: true + - type: textarea + id: to-reproduce + attributes: + label: To Reproduce + description: | + Steps to reproduce the behavior. + If reproducing an issue requires some specific configuration file, please paste it here. + placeholder: | + Steps to reproduce the behavior. + validations: + required: true + - type: textarea + id: version + attributes: + label: Version + description: | + The line returned when passing `--version` command line flag to the binary. For example: + ``` + $ ./victoria-metrics-prod --version + victoria-metrics-20190730-121249-heads-single-node-0-g671d9e55 + ``` + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs + description: | + Check if any warnings or errors were logged by VictoriaMetrics components + or components in communication with VictoriaMetrics (e.g. Prometheus, Grafana). + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: | + If applicable, add screenshots to help explain your problem. + + For VictoriaMetrics health-state issues please provide full-length screenshots + of Grafana dashboards if possible: + * [Grafana dashboard for single-node VictoriaMetrics](https://grafana.com/grafana/dashboards/10229-victoriametrics/) + * [Grafana dashboard for VictoriaMetrics cluster](https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/) + + See how to setup monitoring here: + * [monitoring for single-node VictoriaMetrics](https://docs.victoriametrics.com/#monitoring) + * [monitoring for VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#monitoring) + validations: + required: false + - type: textarea + id: flags + attributes: + label: Used command-line flags + description: | + Please provide the command-line flags used for running VictoriaMetrics and its components. + validations: + required: false + - type: textarea + id: additional-info + attributes: + label: Additional information + placeholder: | + Additional information that doesn't fit elsewhere + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/configuration.yml b/.github/ISSUE_TEMPLATE/configuration.yml new file mode 100644 index 000000000..0bc1c225b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/configuration.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Ask on Slack + url: https://slack.victoriametrics.com/ + about: You can ask for help here! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d6..000000000 --- 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: '' -assignees: '' - ---- - -**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/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..6d2951b98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: Feature request +description: Suggest an idea for this project +labels: [enhancement] +body: + - type: textarea + id: describe-the-problem + attributes: + label: Is your feature request related to a problem? Please describe + render: plain text + description: | + A clear and concise description of what the problem is. + placeholder: | + Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: describe-the-solution + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternative-solutions + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + placeholder: | + I have tried to do `A`, but that doesn't solve a problem completely. + I have tried to do `A` and `B`, but implementing this would be better. + validations: + required: false + - type: textarea + id: feature-additional-info + attributes: + label: Additional information + description: | + Additional information which you consider helpful for implementing this feature. + placeholder: | + Add any other context or screenshots about the feature request here. + validations: + required: false