Merge pull request #97 from Kalaschnik/IssueTemplates

Issue templates
2026-03-11 08:54:32 +00:00 · 2020-07-02 21:50:49 +10:00 · 2020-07-02 21:50:49 +10:00 · 7bee28845f
commit 7bee28845f
parent 9fea313470 8e38891c8b
5 changed files with 91 additions and 102 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@ -0,0 +1,32 @@
+---
+name: "\U0001F41E Bug report"
+about: Create a bug report to help us improve Flow Launcher
+title: "[Describe Your Bug]"
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug/issue**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. ...
+2. ...
+3. ...
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Your System**
+```
+Windows build number: (run "ver" at a command prompt)
+Flow Launcher version: (Settings => About) 
+```
+**Flow Launcher Error Log**
+<!-- 
+     The latest log file can be found here: %AppData%\FlowLauncher\Logs\<version>\<date>.txt
+     or for portable mode: %LocalAppData%\FlowLauncher\<App-Version>\UserData\Logs\<version>\<date>.txt
+     Drag and drop the log file below this comment.
+-->
--- a/.github/ISSUE_TEMPLATE/code-review.md
+++ b/.github/ISSUE_TEMPLATE/code-review.md
@ -0,0 +1,21 @@
+---
+name: "\U0001F50E Code Review"
+about: Describe (bad) code that needs to be improved
+title: "[Describe Problematic Code]"
+labels: 'code review'
+assignees: ''
+
+---
+
+**Point to the corresponding file and line number(s) which could be improved.**
+
+Click on the line number in GitHub to create an anchored link to the corresponding code section. For example:
+
+
+https://github.com/Flow-Launcher/Flow.Launcher/blob/master/Flow.Launcher/Storage/TopMostRecord.cs#L8
+
+Provide your alternative implementation idea:
+
+```
+Code
+```
--- a/.github/ISSUE_TEMPLATE/discussion.md
+++ b/.github/ISSUE_TEMPLATE/discussion.md
@ -0,0 +1,14 @@
+---
+name: "⁉️ Question/Discussion"
+about: Create a report to help us improve
+title: "[Ask a question or propose a change]"
+labels: 'question/discussion'
+assignees: ''
+
+---
+
+**Question**
+Describe your question.
+
+**Discussion**
+Discuss a topic.
--- a/.github/ISSUE_TEMPLATE/feature-request.md
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@ -0,0 +1,24 @@
+---
+name: "⭐ Feature request"
+about: Suggest a new idea or a feature enhacement
+title: "[Describe Your Feature]"
+labels: 'enhancement'
+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.
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@ -1,102 +0,0 @@
-<!-- 
-     ===================================================
-     DO NOT DELETE UNTIL YOU HAVE READ THE FIRST SECTION
-     ===================================================
-
-     To be able to help you we need enough information to find
-     what is causing your issue. Please follow the instructions 
-     and type the requested information where prompted. 
-     
-     ===================================================
-     中文版说明，请仔细阅读并在填写后删除此说明段落，无效的反馈会被直接关闭
-     ===================================================
-     请遵循以下说明，提供我们所需要的信息来，这样我们才能找出导致你
-     遇到的问题的原因，来更好的帮助你。
-     如果可以的话，请附上一份英文的翻译（哪怕是直接使用谷歌翻译）
-     请注意，无效的反馈（尤其是没有填写下面那些信息的反馈）会被直接关闭！
-->
-
-### Are you submitting a bug report?
-
-(write your answer here)
-
-<!-- 
-    If your answer is "Yes", please follow the instructions below. 
-     
-    If your answer is "No", you may delete everything below and then proceed
-    to write your concern. 
-    
-    你是否是在提交一个bug（软件缺陷）？
-    如果你的答案是『是的』，请继续回答下面的提问。
-    如果你的答案是『不是』，你可以删除下面的一切，然后说出你的想法。
-->
-
-<!--
-     Some problems are known of and there are 
-     already workarounds or existing issues.    
-
-     Known problems for 1.3.183:
-     We are aware of the following issues and the following workarounds exist:
-     1. `System.NullReferenceException`: https://github.com/Wox-launcher/Wox/releases/tag/v1.3.475
-     2. `System.UriFormatException`: delete your old theme file
-     3. `System.Threading.Tasks.TaskCanceledException`: https://github.com/Wox-launcher/Wox/releases/tag/v1.3.475
-     4. `System.AggregateException`: see https://github.com/Wox-launcher/Wox/issues/1777
-     
-     If none of them match your case, please continue. 
-     
-     已知问题及解决方案：（略，如果有任何问题请继续提问）
-->
-
-### Steps to reproduce
-
-<!--
-     Write what steps you took in order for this problem to happen.
-     If you do not provide any steps, we cannot replicate your problem
-     and will not be able to help you. 
-
-     复现问题的步骤：
-     在此按顺序一步步说明在问题发生前你做了什么操作。
-     如果你没法说明你的步骤，那么我们无法复现你的问题，也就无法帮助你了。
-->
-
-1.
-2.
-3.
-
-### Flow Launcher Error Window text
-<!-- 
-     Paste below the logs generated by the Flow.Launcher error reporter.
-
-     请在此处粘贴 Flow Launcher 错误报告程序提供的日志。
-->
-
-(paste here)
-
-
-### Detailed logs
-<!-- 
-     Please also provide detailed logs. The latest log file
-     can be found here: %APPDATA%\Flow.Launcher\Logs\version\<date>.txt
-     Drag and drop that file below this comment.
-     In some cases you can skip uploading the the logs, but the chances
-     of us being able to solve the problem will be higher if you do. 
-
-     详细日志：
-     请在此处提供详细日志。你可以在这个目录找到最新的日志：
-     %APPDATA%\Flow.Launcher\Logs\version\<date>.txt
-     直接拖放文件到这个评论就可以上传（国内大部分地区可能需要翻墙才能上传，作为备选方案可以考虑直接在此粘贴文件内容）
-->
-
-(drop your log file here)
-
-### Screenshots (optional)
-<!--
-     If you think it will be helpful to provide a screenshot
-     to better describe your problem, upload it below
-
-     截图（可选）
-     如果你认为截图能够有助于说明你的问题，请在下面上传它。
-->
-
-(drop your screenshot here)
-