From df2f33b5b1077bcbf93caaf915c96224c5d98d4f Mon Sep 17 00:00:00 2001 From: Marcus Efraimsson Date: Tue, 19 Feb 2019 13:08:29 +0100 Subject: [PATCH 1/3] add new issue templates --- .github/ISSUE_TEMPLATE/1-bug_report.md | 31 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature_request.md | 28 +++++++++++++++++++ .github/ISSUE_TEMPLATE/3-question.md | 10 +++++++ 3 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/2-feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/3-question.md diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md new file mode 100644 index 00000000000..4414278becc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +Read before posting: + +- Questions should be posted to https://community.grafana.com +- Search/filter through opened and closed issues for existing similar bug reports: https://github.com/grafana/grafana/issues?utf8=%E2%9C%93&q=is%3Aissue +- Checkout FAQ: https://community.grafana.com/c/howto/faq +- Checkout How to troubleshoot metric query issues: https://community.grafana.com/t/how-to-troubleshoot-metric-query-issues/50 +- Checkout Using Grafana’s Query Inspector to troubleshoot issues: https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630 + +Please answer and include relevant information below: + +### What Grafana version are you using? +### What datasource are you using? +### What OS are you running grafana on? +### What did you do? +### What was the expected result? +### What happened instead? +### If related to metric query / data viz +### Include raw network request & response +See Using Grafana’s Query Inspector to troubleshoot issues and/or How to troubleshoot metric query issues above. + +### Additional context +Add any other relevant context, like browser, platform and/or screenshots about the bug report here. diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.md b/.github/ISSUE_TEMPLATE/2-feature_request.md new file mode 100644 index 00000000000..b0637ebf46f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +Read before posting: + +- Questions should be posted to https://community.grafana.com +- Search through opened and closed issues for existing similar feature requests: https://github.com/grafana/grafana/issues?utf8=%E2%9C%93&q=is%3Aissue +- Write a short and descriptive title describing your feature, e.g. Support X in area Y + +Please answer and include below information: + +### Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is, e.g. I'm always frustrated when [...] + +### Describe possible solutions 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 relevant context, like Grafana version, browser, platform and/or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-question.md b/.github/ISSUE_TEMPLATE/3-question.md new file mode 100644 index 00000000000..adaf6098a28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: 'Questions should be posted to https://community.grafana.com/' +title: '' +labels: '' +assignees: '' + +--- + +Please ask questions on our community site, https://community.grafana.com/. Github are mainly for feature requests and bug reports. From da49fecc30d5fe181dc03649a6fa6c063a02a952 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 7 Mar 2019 10:55:16 +0100 Subject: [PATCH 2/3] Updated templates --- .github/ISSUE_TEMPLATE.md | 16 --------- .github/ISSUE_TEMPLATE/1-bug_report.md | 40 ++++++++++----------- .github/ISSUE_TEMPLATE/2-feature_request.md | 27 ++++---------- .github/ISSUE_TEMPLATE/3-accessibility.md | 26 ++++++++++++++ .github/ISSUE_TEMPLATE/3-question.md | 10 ------ .github/ISSUE_TEMPLATE/4-question.md | 14 ++++++++ 6 files changed, 65 insertions(+), 68 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/3-accessibility.md delete mode 100644 .github/ISSUE_TEMPLATE/3-question.md create mode 100644 .github/ISSUE_TEMPLATE/4-question.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 8086a6b86e5..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -Read before posting: - -- Questions should be posted to https://community.grafana.com. Please search there and here on GitHub for similar issues before creating a new issue. -- Checkout FAQ: https://community.grafana.com/c/howto/faq -- Checkout How to troubleshoot metric query issues: https://community.grafana.com/t/how-to-troubleshoot-metric-query-issues/50 - -Please include this information: -### What Grafana version are you using? -### What datasource are you using? -### What OS are you running grafana on? -### What did you do? -### What was the expected result? -### What happened instead? -### If related to metric query / data viz: -### Include raw network request & response: get by opening Chrome Dev Tools (F12, Ctrl+Shift+I on windows, Cmd+Opt+I on Mac), go the network tab. - diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md index 4414278becc..544ddab89e9 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.md +++ b/.github/ISSUE_TEMPLATE/1-bug_report.md @@ -1,31 +1,29 @@ --- name: Bug report -about: Create a report to help us improve +about: Report a bug you found when using Grafana title: '' -labels: '' +labels: 'type: bug' assignees: '' - --- -Read before posting: + -- Questions should be posted to https://community.grafana.com -- Search/filter through opened and closed issues for existing similar bug reports: https://github.com/grafana/grafana/issues?utf8=%E2%9C%93&q=is%3Aissue -- Checkout FAQ: https://community.grafana.com/c/howto/faq -- Checkout How to troubleshoot metric query issues: https://community.grafana.com/t/how-to-troubleshoot-metric-query-issues/50 -- Checkout Using Grafana’s Query Inspector to troubleshoot issues: https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630 +**What happened**: -Please answer and include relevant information below: +**What you expected to happen**: -### What Grafana version are you using? -### What datasource are you using? -### What OS are you running grafana on? -### What did you do? -### What was the expected result? -### What happened instead? -### If related to metric query / data viz -### Include raw network request & response -See Using Grafana’s Query Inspector to troubleshoot issues and/or How to troubleshoot metric query issues above. +**How to reproduce it (as minimally and precisely as possible)**: -### Additional context -Add any other relevant context, like browser, platform and/or screenshots about the bug report here. +**Anything else we need to know?**: + +**Environment**: +- Grafana version: +- Data source type & version: +- OS Grafana is installed on: +- User OS & Browser: +- Grafana plugins: +- Others: diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.md b/.github/ISSUE_TEMPLATE/2-feature_request.md index b0637ebf46f..17e72c6f1ca 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.md +++ b/.github/ISSUE_TEMPLATE/2-feature_request.md @@ -1,28 +1,13 @@ --- -name: Feature request -about: Suggest an idea for this project +name: Enhancement Request +about: Suggest an enhancement or new feature for the Grafana project title: '' -labels: '' +labels: 'type: feature request' assignees: '' - --- -Read before posting: + -- Questions should be posted to https://community.grafana.com -- Search through opened and closed issues for existing similar feature requests: https://github.com/grafana/grafana/issues?utf8=%E2%9C%93&q=is%3Aissue -- Write a short and descriptive title describing your feature, e.g. Support X in area Y +**What would you like to be added**: -Please answer and include below information: - -### Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is, e.g. I'm always frustrated when [...] - -### Describe possible solutions 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 relevant context, like Grafana version, browser, platform and/or screenshots about the feature request here. \ No newline at end of file +**Why is this needed**: diff --git a/.github/ISSUE_TEMPLATE/3-accessibility.md b/.github/ISSUE_TEMPLATE/3-accessibility.md new file mode 100644 index 00000000000..c8a2d899ff6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-accessibility.md @@ -0,0 +1,26 @@ +--- +name: Accessibility problem or improvement request +about: Help make Grafana be better at keyboard navigation, screen-readable and accessible to all. +labels: 'type: accessibility' +--- + + + +**Steps to reproduce**: + +**Actual Result**: + +**Expected Result** + +**Relevant WCAG Criteria:** [#.#.# WCAG Criterion](link to https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0) + +**Environment**: +- Grafana version: +- Data source type & version: +- User OS & Browser: +- Others: diff --git a/.github/ISSUE_TEMPLATE/3-question.md b/.github/ISSUE_TEMPLATE/3-question.md deleted file mode 100644 index adaf6098a28..00000000000 --- a/.github/ISSUE_TEMPLATE/3-question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Question -about: 'Questions should be posted to https://community.grafana.com/' -title: '' -labels: '' -assignees: '' - ---- - -Please ask questions on our community site, https://community.grafana.com/. Github are mainly for feature requests and bug reports. diff --git a/.github/ISSUE_TEMPLATE/4-question.md b/.github/ISSUE_TEMPLATE/4-question.md new file mode 100644 index 00000000000..7ee98327e4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-question.md @@ -0,0 +1,14 @@ +--- +name: Question / Support request +about: 'Question or support request relating to using Grafana' +title: '' +labels: '' +assignees: '' +--- + +STOP -- PLEASE READ! + +GitHub is not the right place for questions and support requests. + +Please ask questions on our community site: [https://community.grafana.com/](https://community.grafana.com/) + From ec1bb7b995dfddb4dfa613d3829f4fdad4742996 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 7 Mar 2019 11:07:01 +0100 Subject: [PATCH 3/3] Updated issue templates --- .github/ISSUE_TEMPLATE/1-bug_report.md | 4 +--- .github/ISSUE_TEMPLATE/2-feature_request.md | 2 -- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md index 544ddab89e9..eb87a7fc1c9 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.md +++ b/.github/ISSUE_TEMPLATE/1-bug_report.md @@ -1,15 +1,13 @@ --- name: Bug report about: Report a bug you found when using Grafana -title: '' labels: 'type: bug' -assignees: '' --- **What happened**: diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.md b/.github/ISSUE_TEMPLATE/2-feature_request.md index 17e72c6f1ca..0a8b2a63a72 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.md +++ b/.github/ISSUE_TEMPLATE/2-feature_request.md @@ -1,9 +1,7 @@ --- name: Enhancement Request about: Suggest an enhancement or new feature for the Grafana project -title: '' labels: 'type: feature request' -assignees: '' ---