Skip to content

Commit

Permalink
docs: Issue Template (#258)
Browse files Browse the repository at this point in the history
  • Loading branch information
Windsland52 authored Nov 23, 2024
1 parent 5cceed7 commit 8eeb536
Show file tree
Hide file tree
Showing 6 changed files with 283 additions and 0 deletions.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/cn-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Bug 反馈(使用中文)
description: 识别错误、操作异常、连接错误等
labels: ["bug"]
body:
- type: checkboxes
id: checks
attributes:
label: 在提问之前...
description: |
请确认自己完成了要求之后再进行勾选
options:
- label: 我理解 Issue 是用于反馈和解决问题的,而非吐槽评论区,将尽可能提供更多信息帮助问题解决
required: true
- label: 我填写了简短且清晰明确的标题,以便开发者在翻阅 Issue 列表时能快速确定大致问题。而不是“一个建议”、“卡住了”等
required: true
- label: 我使用的是当前更新版本的最新版,且已查看版本发布至今和 Pull Requests 中尚未发布的更新内容,并未提及该 Bug 已被修复的情况
required: true
- label: 我已检查了置顶议题(Pinned Issue)(公告)、活跃议题(Open Issue)、已关闭议题(Closed Issue),确认我的问题未被提及
required: true
- type: textarea
id: describe
attributes:
label: 问题描述
description: 描述问题时请尽可能详细
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: >-
请提供 M9A 版本
placeholder: |
M9A Version:
validations:
required: true
- type: textarea
id: logs
attributes:
label: 日志和配置文件
description: |
**请在关闭 M9A 后,上传以下 3 个文件:**
1. `debug` 文件夹中的 `maa.log` `maa.bak.log` 日志文件,并说明问题出现的大致时间点
2. `config` 文件夹中的 `maa_pi_config.json`(MaaPiCli) 或 `config.json`(MFAWPF) 配置文件
如果你在使用 MacBook,请点击屏幕左上角的“文件”,点击“打开日志文件夹”
**请直接将完整的文件拖拽进来,而非自己裁切或复制的片段;若文件体积过大可压缩后再上传**
placeholder: |
请确认上传文件前已关闭 M9A
validations:
required: true
- type: textarea
id: configuration
attributes:
label: 配置信息
description: |
请说明操作系统及版本、模拟器品牌、模拟器分辨率、DPI、帧率;
若正在使用 MuMu 12 或雷电 9,请说明截图增强是否开启;
最后请说明 GPU 加速推理是否开启,若开启请提供 GPU 型号。
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: 截图或录屏
description: |
`debug` 目录下按功能分类的文件夹内,有一些自动截图的错误图片,若有相关的,请一并打包上传
可上传屏幕截图或录制以帮助解释你的问题,包括但不限于 M9A 软件截图、游戏画面截图
若是**识别相关问题**,请尽可能提供模拟器自带的截图工具截取的无遮挡的**原图**(或通过 adb 截取原图)
用其他的工具(如QQ/微信)截取的图片包含窗口边框且长宽比、分辨率不固定,不利于我们排除bug
若文件体积过大可压缩后再上传
validations:
required: false
- type: textarea
id: others
attributes:
label: 还有别的吗?
description: |
任何能让我们对你所遇到的问题有更多了解的东西
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/cn-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 需求建议(使用中文)
description: 新功能、建议等
labels: ["enhancement"]
body:
- type: checkboxes
id: checks
attributes:
label: 在提问之前...
options:
- label: 我填写了简短且清晰明确的标题,以便开发者在翻阅 Issue 列表时能快速确定大致问题。而不是“一个建议”、“卡住了”等
required: true
- label: 我基本确定这是一个新功能/建议,而不是遇到了 Bug(不确定的话请附上日志)
required: true
- label: 我使用的是当前更新版本的最新版,且已查看版本发布至今和 Pull Requests 中尚未发布的更新内容,确认我的建议未被提及
required: true
- label: 我已检查了置顶议题(Pinned Issue)(公告)、活跃议题(Open Issue)、已关闭议题(Closed Issue),确认我的建议未被提及
required: true
- type: textarea
id: describe
attributes:
label: 说说你遇到的问题?
validations:
required: false
- type: textarea
id: solution
attributes:
label: 有什么好的想法?
validations:
required: false
- type: textarea
id: additional
attributes:
label: 其他内容
description: 关于该需求建议的任何其他背景或屏幕截图。
validations:
required: false
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/cn-others.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: 其他议题(使用中文)
description: 提出问题,而不是 Bug 反馈或需求建议
labels: ["question"]
body:
- type: textarea
id: describe
attributes:
label: 说说你遇到的问题?
validations:
required: false
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/en-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: Bug Report (in English)
description: >-
Recognition errors, operation abnormalities,
connection errors, etc.
labels: ["bug"]
body:
- type: checkboxes
id: checks
attributes:
label: Before raising the issue...
description: |
Please ensure that you have completed the requirements before checking the box.
options:
- label: >-
I understand that Issues are for feedback and problem solving,
not trolling the comments section, and will provide as
much information as possible to help solve the problem.
required: true
- label: >-
I filled in a short, clear title
so that developers could quickly identify the general problem
when going through the issue list.
Instead of "Some suggestions", "Stuck", etc.
required: true
- label: >-
I am using the latest version of the current update and have reviewed
both the updates released so far and the unreleased changes in the Pull Requests,
there is no mention of the bug being fixed.
required: true
- label: >-
I have reviewed the Pinned issue (Announcements), Open issues, and Closed issues
to ensure that my issue has not been mentioned.
required: true
- type: textarea
id: describe
attributes:
label: Description
description: Please provide a detailed description of your issue.
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: >-
Please provide the M9A version.
placeholder: |
M9A Version:
validations:
required: true
- type: textarea
id: logs
attributes:
label: Log and config files
description: >-
**After closing M9A, upload the following 3 files:**
1. The `maa.log` and `maa.bak.log` log file in the `debug` folder, and indicate the approximate point in time when the problem occurred.
2. The `maa_pi_config.json`(MaaPiCli) or `config.json`(MFAWPF) config file in the `config` folder
If you are using MacBook, please click the "File" option in the top-left corner of the screen, then click "Open Log Folder".
**Please drag and drop the full file in, not your own cuttings or copies;**
**compress it before uploading if too large.**
placeholder: |
Please confirm that M9A is not running before uploading files.
validations:
required: true
- type: textarea
id: configuration
attributes:
label: Configuration information
description: |
Please specify the operating system and version, emulator brand, emulator resolution, DPI, and frame rate;
If you are using MuMu 12 or LDPlayer 9, please specify whether Screenshot Enhancement is enabled;
Finally, please specify whether GPU accelerated inference is enabled, and if so, provide the GPU model.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots or recordings
description: >-
In the `debug` directory, within the functionally categorized folders,
there are some error images captured automatically.
If related to this issue, please upload them together.
If available, upload screenshots and recordings to help explain your problem,
including but not limited to screenshots of M9A software,
screenshots of game screens.
If the problem is **recognition related**, please help by providing
the **original image** taken by the emulator's own screenshot tool
(or via adb).
Screenshots taken with other tools may contain the frames of the window/emulator
and their aspect ratio and resolution are inconsistent,
which makes it harder for us to debug.
If the file siz is too large, you may compress it before uploading.
validations:
required: false
- type: textarea
id: others
attributes:
label: Anthing else?
description: |
Anything that will give us more insight into the problem you are having.
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/en-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request (in English)
description: New features, suggestions, etc.
labels: ["enhancement"]
body:
- type: checkboxes
id: checks
attributes:
label: Before raising the issue...
options:
- label: I filled in a short, clear title so that developers could quickly identify the general problem when going through the issue list. Instead of "Some suggestions", "Stuck", etc.
required: true
- label: I'm probably sure this is a new feature/suggestion and not a bug encountered (please attach logs if you're not sure)
required: true
- label: I am using the latest version of the current update and have reviewed both the updates released so far and the unreleased changes in the Pull Requests, but there is no mention of this feature/suggestion being added.
required: true
- label: I have reviewed the Pinned issue (Announcements), Open issues, and Closed issues to ensure that my feature/suggestion has not been mentioned.
required: true
- type: textarea
id: describe
attributes:
label: The problems you have encountered?
validations:
required: false
- type: textarea
id: solution
attributes:
label: Any good ideas?
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional
description: Any other background, screen shots, etc.
validations:
required: false
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/en-others.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Others (in English)
description: Ask a question rather than a bug report or feature request.
labels: ["question"]
body:
- type: textarea
id: describe
attributes:
label: The problems you have encountered?
validations:
required: false

0 comments on commit 8eeb536

Please sign in to comment.