Skip to content

Commit a38071d

Browse files
SSttuuddyySSttuuddyy
authored
Initial commit
0 parents  commit a38071d

37 files changed

Lines changed: 2396 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/cn-bug-report.yaml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Bug 反馈（使用中文）
2+
description: 识别错误、操作异常、连接错误等
3+
labels: ["bug"]
4+
body:
5+
- type: checkboxes
6+
id: checks
7+
attributes:
8+
label: 在提问之前...
9+
description: |
10+
请确认自己完成了要求之后再进行勾选
11+
options:
12+
- label: 我理解 Issue 是用于反馈和解决问题的，而非吐槽评论区，将尽可能提供更多信息帮助问题解决
13+
required: true
14+
- label: 我填写了简短且清晰明确的标题，以便开发者在翻阅 Issue 列表时能快速确定大致问题。而不是“一个建议”、“卡住了”等
15+
required: true
16+
- label: 我使用的是当前更新版本的最新版，且已查看版本发布至今和 Pull Requests 中尚未发布的更新内容，并未提及该 Bug 已被修复的情况
17+
required: true
18+
- label: 我已检查了置顶议题（Pinned Issue）（公告）、活跃议题（Open Issue）、已关闭议题（Closed Issue），确认我的问题未被提及
19+
required: true
20+
- type: textarea
21+
id: describe
22+
attributes:
23+
label: 问题描述
24+
description: 描述问题时请尽可能详细
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: version
29+
attributes:
30+
label: Version
31+
description: >-
32+
请提供 MXX 版本
33+
placeholder: |
34+
MXX Version:
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: logs
39+
attributes:
40+
label: 日志和配置文件
41+
description: |
42+
**请在关闭 MXX 后，上传以下 3 个文件：**
43+
1. `debug` 文件夹中的 `maa.log` `maa.bak.log` 日志文件，并说明问题出现的大致时间点
44+
2. `config` 文件夹中的 `maa_pi_config.json`(MaaPiCli) 配置文件
45+
46+
如果你在使用 MacBook，请点击屏幕左上角的“文件”，点击“打开日志文件夹”
47+
**请直接将完整的文件拖拽进来，而非自己裁切或复制的片段；若文件体积过大可压缩后再上传**
48+
placeholder: |
49+
请确认上传文件前已关闭 MXX
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: configuration
54+
attributes:
55+
label: 配置信息
56+
description: |
57+
请说明操作系统及版本、模拟器品牌、模拟器分辨率、DPI、帧率；
58+
若正在使用 MuMu 12 或雷电 9，请说明截图增强是否开启；
59+
最后请说明 GPU 加速推理是否开启，若开启请提供 GPU 型号。
60+
validations:
61+
required: true
62+
- type: textarea
63+
id: screenshots
64+
attributes:
65+
label: 截图或录屏
66+
description: |
67+
`debug` 目录下按功能分类的文件夹内，有一些自动截图的错误图片，若有相关的，请一并打包上传
68+
69+
可上传屏幕截图或录制以帮助解释你的问题，包括但不限于 MXX 软件截图、游戏画面截图、
70+
MXX debug 截图（`debug/vision` 路径图片，在修改 `config/maa_option.json` 中 `save_draw` 为 `true` 后再次运行 MXX 获取）
71+
若是**识别相关问题**，请尽可能提供模拟器自带的截图工具截取的无遮挡的**原图**（或通过 adb 截取原图）
72+
用其他的工具（如QQ/微信）截取的图片包含窗口边框且长宽比、分辨率不固定，不利于我们排除bug
73+
若文件体积过大可压缩后再上传
74+
validations:
75+
required: false
76+
- type: textarea
77+
id: others
78+
attributes:
79+
label: 还有别的吗？
80+
description: |
81+
任何能让我们对你所遇到的问题有更多了解的东西
82+
validations:
83+
required: false

‎.github/ISSUE_TEMPLATE/cn-feature-request.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 需求建议（使用中文）
2+
description: 新功能、建议等
3+
labels: ["enhancement"]
4+
body:
5+
- type: checkboxes
6+
id: checks
7+
attributes:
8+
label: 在提问之前...
9+
options:
10+
- label: 我填写了简短且清晰明确的标题，以便开发者在翻阅 Issue 列表时能快速确定大致问题。而不是“一个建议”、“卡住了”等
11+
required: true
12+
- label: 我基本确定这是一个新功能/建议，而不是遇到了 Bug（不确定的话请附上日志）
13+
required: true
14+
- label: 我使用的是当前更新版本的最新版，且已查看版本发布至今和 Pull Requests 中尚未发布的更新内容，确认我的建议未被提及
15+
required: true
16+
- label: 我已检查了置顶议题（Pinned Issue）（公告）、活跃议题（Open Issue）、已关闭议题（Closed Issue），确认我的建议未被提及
17+
required: true
18+
- type: textarea
19+
id: describe
20+
attributes:
21+
label: 说说你遇到的问题？
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: 有什么好的想法？
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: additional
32+
attributes:
33+
label: 其他内容
34+
description: 关于该需求建议的任何其他背景或屏幕截图。
35+
validations:
36+
required: false

‎.github/ISSUE_TEMPLATE/cn-others.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 其他议题（使用中文）
2+
description: 提出问题，而不是 Bug 反馈或需求建议
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
id: describe
7+
attributes:
8+
label: 说说你遇到的问题？
9+
validations:
10+
required: false

‎.github/ISSUE_TEMPLATE/en-bug-report.yaml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Bug Report (in English)
2+
description: >-
3+
Recognition errors, operation abnormalities,
4+
connection errors, etc.
5+
labels: ["bug"]
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
label: Before raising the issue...
11+
description: |
12+
Please ensure that you have completed the requirements before checking the box.
13+
options:
14+
- label: >-
15+
I understand that Issues are for feedback and problem solving,
16+
not trolling the comments section, and will provide as
17+
much information as possible to help solve the problem.
18+
required: true
19+
- label: >-
20+
I filled in a short, clear title
21+
so that developers could quickly identify the general problem
22+
when going through the issue list.
23+
Instead of "Some suggestions", "Stuck", etc.
24+
required: true
25+
- label: >-
26+
I am using the latest version of the current update and have reviewed
27+
both the updates released so far and the unreleased changes in the Pull Requests,
28+
there is no mention of the bug being fixed.
29+
required: true
30+
- label: >-
31+
I have reviewed the Pinned issue (Announcements), Open issues, and Closed issues
32+
to ensure that my issue has not been mentioned.
33+
required: true
34+
- type: textarea
35+
id: describe
36+
attributes:
37+
label: Description
38+
description: Please provide a detailed description of your issue.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: version
43+
attributes:
44+
label: Version
45+
description: >-
46+
Please provide the MXX version.
47+
placeholder: |
48+
MXX Version:
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Log and config files
55+
description: >-
56+
**After closing MXX, upload the following 3 files:**
57+
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.
58+
2. The `maa_pi_config.json`(MaaPiCli) config file in the `config` folder
59+
60+
If you are using MacBook, please click the "File" option in the top-left corner of the screen, then click "Open Log Folder".
61+
**Please drag and drop the full file in, not your own cuttings or copies;**
62+
**compress it before uploading if too large.**
63+
placeholder: |
64+
Please confirm that MXX is not running before uploading files.
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: configuration
69+
attributes:
70+
label: Configuration information
71+
description: |
72+
Please specify the operating system and version, emulator brand, emulator resolution, DPI, and frame rate;
73+
If you are using MuMu 12 or LDPlayer 9, please specify whether Screenshot Enhancement is enabled;
74+
Finally, please specify whether GPU accelerated inference is enabled, and if so, provide the GPU model.
75+
validations:
76+
required: true
77+
- type: textarea
78+
id: screenshots
79+
attributes:
80+
label: Screenshots or recordings
81+
description: >-
82+
In the `debug` directory, within the functionally categorized folders,
83+
there are some error images captured automatically.
84+
If related to this issue, please upload them together.
85+
86+
If available, upload screenshots and recordings to help explain your problem,
87+
including but not limited to screenshots of MXX software,
88+
screenshots of game screens, MXX debug screenshots (`debug/vision` path pictures,
89+
after modifying `save_draw` in `config/maa_option.json` to `true`, run MXX again to obtain)
90+
91+
If the problem is **recognition related**, please help by providing
92+
the **original image** taken by the emulator's own screenshot tool
93+
(or via adb).
94+
95+
Screenshots taken with other tools may contain the frames of the window/emulator
96+
and their aspect ratio and resolution are inconsistent,
97+
which makes it harder for us to debug.
98+
99+
If the file siz is too large, you may compress it before uploading.
100+
101+
validations:
102+
required: false
103+
- type: textarea
104+
id: others
105+
attributes:
106+
label: Anthing else?
107+
description: |
108+
Anything that will give us more insight into the problem you are having.
109+
validations:
110+
required: false

‎.github/ISSUE_TEMPLATE/en-feature-request.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request (in English)
2+
description: New features, suggestions, etc.
3+
labels: ["enhancement"]
4+
body:
5+
- type: checkboxes
6+
id: checks
7+
attributes:
8+
label: Before raising the issue...
9+
options:
10+
- 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.
11+
required: true
12+
- label: I'm probably sure this is a new feature/suggestion and not a bug encountered (please attach logs if you're not sure)
13+
required: true
14+
- 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.
15+
required: true
16+
- label: I have reviewed the Pinned issue (Announcements), Open issues, and Closed issues to ensure that my feature/suggestion has not been mentioned.
17+
required: true
18+
- type: textarea
19+
id: describe
20+
attributes:
21+
label: The problems you have encountered?
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: solution
26+
attributes:
27+
label: Any good ideas?
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: additional
32+
attributes:
33+
label: Additional
34+
description: Any other background, screen shots, etc.
35+
validations:
36+
required: false

‎.github/ISSUE_TEMPLATE/en-others.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Others (in English)
2+
description: Ask a question rather than a bug report or feature request.
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
id: describe
7+
attributes:
8+
label: The problems you have encountered?
9+
validations:
10+
required: false

‎.github/cliff.toml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
[remote.github]
2+
owner = "MaaXYZ"
3+
repo = "MaaPracticeBoilerplate"
4+
#自用时换成自己的仓库owner和repo
5+
#注意，本地git user需与github一致才能实现成功@
6+
[changelog]
7+
# 标题
8+
header = """
9+
# 更新日志
10+
"""
11+
12+
body = """
13+
{%- macro remote_url() -%}
14+
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
15+
{%- endmacro -%}
16+
17+
{% macro print_commit(commit) -%}
18+
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
19+
{% if commit.breaking %}[**breaking**] {% endif %}\
20+
{{ commit.message | split(pat="\n") | first | upper_first }} \
21+
@{{ commit.author.name }}
22+
{%- if commit.footers -%}
23+
{%- for footer in commit.footers -%}
24+
{%- if footer.token == "Co-authored-by" -%}
25+
{%- set co_author_name = footer.value | split(pat=" <") | first | trim %} @{{ co_author_name }}
26+
{%- endif -%}
27+
{%- endfor -%}
28+
{%- endif %}
29+
{% endmacro -%}
30+
31+
{% if version %}\
32+
## {{ version | trim_start_matches(pat="v") }} ({{ timestamp | date(format="%Y-%m-%d") }})
33+
{% else %}\
34+
## 未发布
35+
{% endif %}\
36+
37+
{% for group, commits in commits | group_by(attribute="group") %}
38+
### {{ group | striptags | trim | upper_first }}
39+
{% for commit in commits
40+
| filter(attribute="scope")
41+
| sort(attribute="scope") %}
42+
{{ self::print_commit(commit=commit) }}
43+
{%- endfor %}
44+
{% for commit in commits %}
45+
{%- if not commit.scope -%}
46+
{{ self::print_commit(commit=commit) }}
47+
{% endif -%}
48+
{% endfor -%}
49+
{% endfor -%}
50+
{%- if github -%}
51+
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
52+
## 新贡献者 ❤️
53+
{% endif %}\
54+
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
55+
* @{{ contributor.username }} made their first contribution
56+
{%- if contributor.pr_number %} in \
57+
[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
58+
{%- endif %}
59+
{%- endfor -%}
60+
{%- endif %}
61+
"""
62+
63+
# 尾部
64+
footer = """
65+
"""
66+
67+
[git]
68+
# 过滤提交
69+
conventional_commits = true # 使用约定式提交格式
70+
filter_unconventional = false # 不过滤非约定式提交
71+
# 启用完整的 commit 信息
72+
split_commits = false
73+
# 保留完整的 commit body
74+
protect_breaking_commits = false
75+
commit_parsers = [
76+
{ message = "^feat", group = "<!-- 0 -->✨ 新功能" },
77+
{ message = "^fix", group = "<!-- 1 -->🐛 Bug修复" },
78+
{ message = "^docs", group = "<!-- 4 -->📚 文档" },
79+
{ message = "^perf", group = "<!-- 3 -->🚀 性能优化" },
80+
{ message = "^refactor", group = "<!-- 2 -->🚜 代码重构" },
81+
{ message = "^style", group = "<!-- 5 -->🎨 样式" },
82+
{ message = "^test", group = "<!-- 6 -->🧪 测试" },
83+
{ message = "^chore\\(deps\\)", group = "📦 依赖更新" },
84+
{ message = "^chore", group = "<!-- 8 -->🔧 日常维护" },
85+
{ message = "^ci", group = "<!-- 7 -->⚙️ 持续集成" },
86+
{ body = ".*security", group = "<!-- 9 -->🔒 安全" },
87+
{ message = "^revert", group = "<!-- 10 -->◀️ 撤销" },
88+
]
89+
90+
# 忽略这些提交
91+
ignore_tags = "rc"
92+
93+
# 排序规则
94+
sort_commits = "oldest"
95+
96+
# 启用GitHub集成
97+
[git.github]
98+
commits = true

0 commit comments

Comments
 (0)