From bb5366300a9f9d2361a36094acdeba847c27a95e Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:42:53 -0300 Subject: [PATCH 1/6] Don't allow blank issues --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..9c78f2c84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Tasmota Docs + url: https://tasmota.github.io/docs/#/ + about: All the information related to Tasmota + - name: Tasmota Support Chat + url: https://discord.gg/Ks2Kzd4 + about: Chat for feedback, questions and troubleshooting. From 38d64634abd3d4bee327bd42d8b441f230bd048b Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:46:57 -0300 Subject: [PATCH 2/6] Update Bug Report to Problem Report As sometimes a bug is reported as a troubleshooting and also a troubleshooting issue is reported as a bug, and as both templates are nearly the same, it is better to have just one problem template. --- .github/ISSUE_TEMPLATE/Bug_report.md | 37 ++++++++++++++-------------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 373d518cb..847958093 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,31 +1,32 @@ --- -name: Bug report +name: Problem report about: Create a report to help us improve --- -> **GUIDE** -> -> This BUG issue template is meant to REPORT Tasmota software BUGS ONLY> -> -> Please DO NOT OPEN AN ISSUE: -> - If your Tasmota version is not the latest from the development branch, please update your device before submitting your issue. Your problem might already be solved. The latest precompiled binaries of Tasmota can be downloaded from http://thehackbox.org/tasmota/ -> - If you have a issue when flashing was done via Tuya Convert -> - If your issue is a flashing issue, please address it to the [Tasmota Support Chat](https://discord.gg/Ks2Kzd4) -> - If your issue is compilation problem, please address it to the [Tasmota Support Chat](https://discord.gg/Ks2Kzd4) -> - If your issue has been addressed before (i.e., duplicated issue), please ask in the original issue -> - If your issue is a Wi-Fi problem or MQTT problem, please try the steps provided in the [FAQ](https://github.com/arendst/Tasmota/wiki/FAQ) and troubleshooting wiki articles -> -> Please take a few minutes to complete the requested information below. Our ability to provide assistance is greatly hampered without it. The details requested potentially affect which options to pursue. The small amount of time you spend completing the template will also help the volunteers providing the assistance to you to reduce the time required to help you. + + +### PROBLEM DESCRIPTION +_A clear and concise description of what the problem is._ ### REQUESTED INFORMATION _Make sure your have performed every step and checked the applicable boxes before submitting your issue. Thank you!_ -**FAILURE TO COMPLETE THE REQUESTED INFORMATION WILL RESULT IN YOUR ISSUE BEING CLOSED** - - [ ] Read the [Contributing Guide and Policy](https://github.com/arendst/Tasmota/blob/development/CONTRIBUTING.md) and [the Code of Conduct](https://github.com/arendst/Tasmota/blob/development/CODE_OF_CONDUCT.md) - [ ] Searched the problem in [issues](https://github.com/arendst/Tasmota/issues) - [ ] Searched the problem in the [wiki](https://github.com/arendst/Tasmota/wiki/Troubleshooting) From a2a3e1ad7b2043d3189f12174933e7b9bc335736 Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:47:36 -0300 Subject: [PATCH 3/6] Update Feature_request.md --- .github/ISSUE_TEMPLATE/Feature_request.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 5aa100e01..43fd36e7c 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -3,7 +3,12 @@ name: Feature request about: Suggest an idea for this project --- -> Please take a few minutes to complete the requested information below. Our ability to provide assistance is greatly hampered without it. The details requested potentially affect which options to pursue. The small amount of time you spend completing the template will also help the volunteers providing the assistance to you to reduce the time required to help you. + **Have you looked for this feature in other issues and in the wiki?** From 278e913709aa2c52d0acd7c218e6aa5611c738f3 Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:48:35 -0300 Subject: [PATCH 4/6] Merging Troubleshooting and Bug reports into one --- .github/ISSUE_TEMPLATE/Custom.md | 67 -------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Custom.md diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md deleted file mode 100644 index 3b30c5f18..000000000 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: Troubleshooting -about: Users Troubleshooting Help ---- - -> **GUIDE** -> -> This troubleshooting issue template is meant to help Tasmota users with difficult problems. It is aimed to be opened if using the wiki and the support chat could not solve the issue. The Github Issue tracker is NOT a general discussion forum! -> -> Please DO NOT OPEN AN ISSUE: -> - If you have general questions or you need help on Tasmota usage, go to the [Tasmota Support Chat](https://discord.gg/Ks2Kzd4) -> - If your Tasmota version is not the latest from the development branch, please update your device before submitting your issue. Your problem might already be solved. The latest precompiled binaries of Tasmota can be downloaded from http://thehackbox.org/tasmota/ -> - If your issue is about a new device, please use the Tasmota [Template](../wiki/Templates) feature. -> - If your issue is a flashing issue, please address it to the [Tasmota Support Chat](https://discord.gg/Ks2Kzd4) -> - If your issue is compilation problem, please address it to the [Tasmota Support Chat](https://discord.gg/Ks2Kzd4) -> - If your issue has been addressed before (i.e., duplicated issue), please ask in the original issue -> - If your issue is a Wi-Fi problem or MQTT problem, please try the steps provided in the [FAQ](https://github.com/arendst/Tasmota/wiki/FAQ) and troubleshooting wiki articles -> -> Please take a few minutes to complete the requested information below. Our ability to provide assistance is greatly hampered without it. The details requested potentially affect which options to pursue. The small amount of time you spend completing the template will also help the volunteers providing the assistance to you to reduce the time required to help you. - -### ISSUE DESCRIPTION - TROUBLESHOOTING -_A clear description of what the issue is and be as extensive as possible_ - - -### REQUESTED INFORMATION -_Make sure these boxes are checked before submitting your issue. Thank you_ - -**FAILURE TO COMPLETE THE REQUESTED INFORMATION WILL RESULT IN YOUR ISSUE BEING CLOSED** - -- [ ] Read the [Contributing Guide and Policy](https://github.com/arendst/Tasmota/blob/development/CONTRIBUTING.md) and [the Code of Conduct](https://github.com/arendst/Tasmota/blob/development/CODE_OF_CONDUCT.md) -- [ ] Searched the problem in issues (https://github.com/arendst/Tasmota/issues) -- [ ] Searched the problem in the wiki (https://github.com/arendst/Tasmota/wiki/Troubleshooting) -- [ ] Searched the problem in the forum (https://groups.google.com/d/forum/sonoffusers) -- [ ] Searched the problem in the chat (https://discord.gg/Ks2Kzd4) -- [ ] Device used (e.g., Sonoff Basic): _____ -- [ ] Tasmota binary firmware version number used: _____ - - [ ] Pre-compiled - - [ ] Self-compiled - - [ ] IDE / Compiler used: _____ -- [ ] Flashing tools used: _____ -- [ ] Provide the output of this command: ``Backlog Template; Module; GPIO``: - ``` - Configuration output here: - - - ``` -- [ ] If using rules, provide the output of this command: ``Backlog Rule1; Rule2; Rule3``: - ``` - Rules output here: - - - ``` -- [ ] Provide the output of this command: ``Status 0``: - ``` - STATUS 0 output here: - - - ``` -- [ ] Provide the output of the Console log output when you experience your issue; if applicable: - _(Please use_ ``weblog 4`` _for more debug information)_ - ``` - Console output here: - - - ``` - -**(Please, remember to close the issue when the problem has been addressed)** From b9dfa51225658b0abef41cce388bb786fbcf8c24 Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:50:28 -0300 Subject: [PATCH 5/6] Add code of conduct Bot --- .github/config.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/config.yml diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 000000000..6ef38dd6b --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,11 @@ +# Configuration for sentiment-bot - https://github.com/behaviorbot/sentiment-bot + +# *Required* toxicity threshold between 0 and .99 with the higher numbers being the most toxic +# Anything higher than this threshold will be marked as toxic and commented on +sentimentBotToxicityThreshold: .7 + +# *Required* Comment to reply with +sentimentBotReplyComment: > + Please be sure to review the code of conduct and be respectful of other users. + +# Note: the bot will only work if your repository has a Code of Conduct From 5bb42670948a51d85693ee775069eec08014a2ae Mon Sep 17 00:00:00 2001 From: Adrian Scillato <35405447+ascillato@users.noreply.github.com> Date: Fri, 29 Nov 2019 03:52:13 -0300 Subject: [PATCH 6/6] Add issue-close Bot This Bot auto-closes new issues without template --- .github/issue-close-app.yml | 54 +++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/issue-close-app.yml diff --git a/.github/issue-close-app.yml b/.github/issue-close-app.yml new file mode 100644 index 000000000..0fcb996ab --- /dev/null +++ b/.github/issue-close-app.yml @@ -0,0 +1,54 @@ +# CLOSE ISSUE BOT +# --------------- +# A bot which helps you to close issues that don't include some specific contents. +# See how to use it in https://github.com/offu/close-issue-app. + +# Comment that will be sent if an issue is judged to be closed. +comment: >- + This issue has been automatically closed because the issue template is missing or incomplete. + + Filling the template is required so standard questions don't need to be asked again each time. + Our ability to provide assistance is greatly hampered if few minutes are not taken to complete the issue template + with the requested information. The details requested potentially affect which options to pursue. The small amount + of time you spend completing the template will also help the volunteers providing the assistance to you, to reduce + the time required to help you. + + Please, could you be so kind on completing the [issue template](https://github.com/arendst/Tasmota/issues/new/choose) in order to have more information so as to properly help you? + + Thank you for taking the time to report, hopefully it can be resolved soon. + + [Support Information](https://github.com/arendst/Sonoff-Tasmota/blob/development/SUPPORT.md) + + [Wiki](https://tasmota.github.io/docs/#/) for more information. + + [Chat](https://discord.gg/Ks2Kzd4) for more user experience. + + [Community](https://groups.google.com/d/forum/sonoffusers) for forum. + + [Code of Conduct](https://github.com/arendst/Sonoff-Tasmota/blob/development/CODE_OF_CONDUCT.md) + + [Contributing Guideline and Policy](https://github.com/arendst/Sonoff-Tasmota/blob/development/CONTRIBUTING.md) + +issueConfigs: +# There can be several configs for different kind of issues. +- content: +# template 1: bug report + - "PROBLEM DESCRIPTION" + - "REQUESTED INFORMATION" + - "TO REPRODUCE" + - "EXPECTED BEHAVIOUR" +- content: +# template 2: feature request + - "Have you looked for this feature in other issues and in the wiki" + - "Describe the solution you'd like" + +# Optional configuration: +# +# whether the keywords are case-insensitive +# default value is false, which means keywords are case-sensitive +caseInsensitive: true +# the label that will be added when the bot close an issue +# The bot will only add a label if this property is set. +label: "template missing/incomplete" +# The issue is judged to be legal if it includes all keywords from any of these two configs. +# Or it will be closed by the app.