Skip to content

Commit 873284b

Browse files
committed
feat(Labels, Issue Templates): update issue labels and templates for improved clarity and organization
- Enhanced label descriptions in labels.yml for better understanding of issue types and priorities. - Added new labels for bug severity, areas of concern, and issue statuses to facilitate better categorization. - Updated issue templates for bug reports, feature requests, and questions to reflect new label options and areas. - Improved localization in issue templates for better accessibility in both English and Chinese.
1 parent 59b7130 commit 873284b

8 files changed

Lines changed: 153 additions & 77 deletions

File tree

.github/ISSUE_TEMPLATE/bug-report.en.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ body:
1616
label: Area
1717
description: Where does the issue happen?
1818
options:
19-
- Combat
20-
- Cards
21-
- Powers
22-
- Relics
19+
- Public API
20+
- Mod settings
2321
- UI
22+
- Assets
23+
- Audio
2424
- Localization
25+
- Mod loading
26+
- Compatibility
2527
- Build/CI
2628
- Docs
29+
- Tests / samples
2730
- Other
2831
validations:
2932
required: true
@@ -32,9 +35,9 @@ body:
3235
attributes:
3336
label: Severity
3437
options:
35-
- Crash
38+
- Critical / crash
3639
- Broken feature
37-
- Regression
40+
- Major / regression
3841
- Minor
3942
validations:
4043
required: true

.github/ISSUE_TEMPLATE/bug-report.zh-CN.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ body:
1616
label: 模块范围
1717
description: 问题发生在哪个模块?
1818
options:
19-
- Combat(战斗)
20-
- Cards(卡牌)
21-
- Powers(能力)
22-
- Relics(遗物)
19+
- Public API(公开 API)
20+
- Mod settings(模组设置)
2321
- UI
22+
- Assets(资源)
23+
- Audio(音频)
2424
- Localization(本地化)
25+
- Mod loading(模组加载)
26+
- Compatibility(兼容性)
2527
- Build/CI(构建/CI)
2628
- Docs(文档)
29+
- Tests / samples(测试 / 示例)
2730
- Other(其他)
2831
validations:
2932
required: true
@@ -32,9 +35,9 @@ body:
3235
attributes:
3336
label: 严重程度
3437
options:
35-
- Crash(崩溃)
38+
- Critical / crash(严重 / 崩溃)
3639
- Broken feature(功能不可用)
37-
- Regression(回归)
40+
- Major / regression(主要问题 / 回归)
3841
- Minor(轻微)
3942
validations:
4043
required: true

.github/ISSUE_TEMPLATE/feature-request.en.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,17 @@ body:
1313
attributes:
1414
label: Area
1515
options:
16-
- Combat
17-
- Cards
18-
- Powers
19-
- Relics
16+
- Public API
17+
- Mod settings
2018
- UI
19+
- Assets
20+
- Audio
2121
- Localization
22+
- Mod loading
23+
- Compatibility
2224
- Build/CI
2325
- Docs
26+
- Tests / samples
2427
- Other
2528
validations:
2629
required: true

.github/ISSUE_TEMPLATE/feature-request.zh-CN.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,17 @@ body:
1313
attributes:
1414
label: 模块范围
1515
options:
16-
- Combat(战斗)
17-
- Cards(卡牌)
18-
- Powers(能力)
19-
- Relics(遗物)
16+
- Public API(公开 API)
17+
- Mod settings(模组设置)
2018
- UI
19+
- Assets(资源)
20+
- Audio(音频)
2121
- Localization(本地化)
22+
- Mod loading(模组加载)
23+
- Compatibility(兼容性)
2224
- Build/CI(构建/CI)
2325
- Docs(文档)
26+
- Tests / samples(测试 / 示例)
2427
- Other(其他)
2528
validations:
2629
required: true

.github/ISSUE_TEMPLATE/question.en.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ body:
1010
label: Area
1111
options:
1212
- Usage
13-
- API design
13+
- Public API / API design
14+
- Mod settings
15+
- Compatibility
1416
- Build/CI
1517
- Docs
18+
- Tests / samples
1619
- Other
1720
validations:
1821
required: true

.github/ISSUE_TEMPLATE/question.zh-CN.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ body:
1010
label: 范围
1111
options:
1212
- Usage(使用)
13-
- API design(API 设计)
13+
- Public API / API design(公开 API / API 设计)
14+
- Mod settings(模组设置)
15+
- Compatibility(兼容性)
1416
- Build/CI(构建/CI)
1517
- Docs(文档)
18+
- Tests / samples(测试 / 示例)
1619
- Other(其他)
1720
validations:
1821
required: true

.github/labels.yml

Lines changed: 102 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,134 @@
11
- name: type/bug
22
color: d73a4a
3-
description: Something isn't working.
3+
description: Defect or incorrect behavior in RitsuLib.
44
- name: type/feature
55
color: a2eeef
6-
description: New feature or request.
6+
description: Feature request or behavior improvement.
77
- name: type/question
88
color: d876e3
9-
description: Further information is requested.
9+
description: Usage, design, or contribution question.
1010
- name: type/docs
1111
color: 0075ca
12-
description: Documentation related changes.
12+
description: Documentation, examples, or README work.
1313
- name: type/chore
1414
color: cfd3d7
15-
description: Maintenance / refactor / build tooling.
15+
description: Maintenance, refactor, tooling, or dependency work.
16+
17+
- name: bug
18+
color: d73a4a
19+
description: Something is broken or behaving incorrectly.
20+
- name: enhancement
21+
color: a2eeef
22+
description: Feature request or behavior improvement.
23+
- name: documentation
24+
color: 0075ca
25+
description: Documentation, examples, or README changes.
26+
- name: question
27+
color: d876e3
28+
description: Question or discussion; may need clarification before action.
29+
- name: duplicate
30+
color: cfd3d7
31+
description: Duplicates an existing issue or pull request.
32+
- name: invalid
33+
color: e4e669
34+
description: Not actionable, not reproducible, or outside project scope.
35+
- name: wontfix
36+
color: ffffff
37+
description: Accepted as not planned for this project.
38+
- name: noise
39+
color: eeeeee
40+
description: Low-value automated/noisy report; usually safe to close after review.
41+
- name: spam
42+
color: "000000"
43+
description: Spam or abusive content.
44+
- name: help wanted
45+
color: 008672
46+
description: Maintainer welcomes external help.
47+
- name: good first issue
48+
color: 7057ff
49+
description: Good for a first external contribution.
1650

1751
- name: status/needs-triage
18-
color: fbca04
19-
description: Needs initial review and routing.
52+
color: ededed
53+
description: Needs maintainer or analyzer triage.
2054
- name: status/needs-info
55+
color: d4c5f9
56+
description: Waiting for more information from reporter or author.
57+
- name: status/confirmed
58+
color: 0e8a16
59+
description: Confirmed and actionable.
60+
- name: status/in-progress
2161
color: fbca04
22-
description: Reporter input needed to proceed.
62+
description: Work is actively in progress.
2363
- name: status/blocked
2464
color: b60205
25-
description: Blocked by external dependency or upstream changes.
65+
description: Blocked by missing dependency, upstream issue, or decision.
66+
- name: status/needs-review
67+
color: 1d76db
68+
description: Ready for maintainer review.
2669

2770
- name: priority/p0
2871
color: b60205
29-
description: Drop everything.
72+
description: Emergency; blocks releases or core workflows.
3073
- name: priority/p1
3174
color: d93f0b
32-
description: High priority.
75+
description: High priority regression or high-impact work.
3376
- name: priority/p2
3477
color: fbca04
35-
description: Medium priority.
78+
description: Normal priority; useful but not urgent.
3679
- name: priority/p3
37-
color: 0e8a16
38-
description: Low priority.
39-
40-
- name: area/combat
41-
color: 1d76db
42-
description: Combat-related.
43-
- name: area/cards
44-
color: 1d76db
45-
description: Cards-related.
46-
- name: area/powers
47-
color: 1d76db
48-
description: Powers-related.
49-
- name: area/relics
50-
color: 1d76db
51-
description: Relics-related.
52-
- name: area/ui
53-
color: 1d76db
54-
description: UI-related.
55-
- name: area/localization
56-
color: 1d76db
57-
description: Localization-related.
58-
- name: area/build
59-
color: 1d76db
60-
description: Build/CI tooling.
61-
- name: area/docs
62-
color: 1d76db
63-
description: Documentation.
64-
- name: area/other
65-
color: 1d76db
66-
description: Other / unclear area.
80+
color: c5def5
81+
description: Low priority or backlog.
6782

68-
- name: severity/crash
83+
- name: severity/critical
6984
color: b60205
70-
description: Crash / hard failure.
85+
description: Crash, data loss, or unusable core behavior.
7186
- name: severity/broken
87+
color: d73a4a
88+
description: A feature path is effectively unusable.
89+
- name: severity/major
7290
color: d93f0b
73-
description: Broken feature.
91+
description: Significant bug with workaround or limited scope.
7492
- name: severity/regression
7593
color: fbca04
7694
description: Regression from previous behavior.
7795
- name: severity/minor
78-
color: 0e8a16
79-
description: Minor issue.
96+
color: fbca04
97+
description: Minor defect, polish issue, or low-impact bug.
98+
99+
- name: area/api
100+
color: bfdadc
101+
description: Public API, contracts, or compatibility surface.
102+
- name: area/settings
103+
color: bfdadc
104+
description: Mod settings UI, config entries, persistence, or input handling.
105+
- name: area/ui
106+
color: bfdadc
107+
description: User interface, layout, controls, or visual behavior.
108+
- name: area/assets
109+
color: bfdadc
110+
description: Textures, atlases, resource paths, or asset loading.
111+
- name: area/audio
112+
color: bfdadc
113+
description: FMOD, banks, sound events, or audio playback.
114+
- name: area/localization
115+
color: bfdadc
116+
description: Localization loading, text keys, translations, or language data.
117+
- name: area/mod-loading
118+
color: bfdadc
119+
description: Initialization, assembly loading, content registration, or patch lifecycle.
120+
- name: area/compatibility
121+
color: bfdadc
122+
description: Compatibility with game versions, other mods, or runtime environments.
123+
- name: area/build
124+
color: bfdadc
125+
description: Build, packaging, CI, NuGet, or project setup.
126+
- name: area/docs
127+
color: bfdadc
128+
description: Documentation site, examples, README, or guide content.
129+
- name: area/tests
130+
color: bfdadc
131+
description: Tests, analyzers, samples, or validation tooling.
132+
- name: area/other
133+
color: ededed
134+
description: Area is unclear or does not fit existing categories.

.github/workflows/issue-auto-label.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,25 @@ jobs:
3737
function addArea(v) {
3838
if (!v) return;
3939
const x = v.toLowerCase();
40-
if (x.includes("combat") || x.includes("战斗")) return labels.add("area/combat");
41-
if (x.includes("cards") || x.includes("卡牌")) return labels.add("area/cards");
42-
if (x.includes("powers") || x.includes("能力")) return labels.add("area/powers");
43-
if (x.includes("relics") || x.includes("遗物")) return labels.add("area/relics");
40+
if (x.includes("api") || x.includes("usage") || x.includes("公开")) return labels.add("area/api");
41+
if (x.includes("settings") || x.includes("设置")) return labels.add("area/settings");
42+
if (x.includes("assets") || x.includes("资源")) return labels.add("area/assets");
43+
if (x.includes("audio") || x.includes("音频")) return labels.add("area/audio");
4444
if (x.includes("localization") || x.includes("本地化")) return labels.add("area/localization");
45+
if (x.includes("mod loading") || x.includes("模组加载")) return labels.add("area/mod-loading");
46+
if (x.includes("compatibility") || x.includes("兼容")) return labels.add("area/compatibility");
4547
if (x.includes("build") || x.includes("构建")) return labels.add("area/build");
4648
if (x.includes("docs") || x.includes("文档")) return labels.add("area/docs");
49+
if (x.includes("tests") || x.includes("samples") || x.includes("测试") || x.includes("示例")) return labels.add("area/tests");
4750
if (x.includes("ui")) return labels.add("area/ui");
4851
return labels.add("area/other");
4952
}
5053
5154
function addSeverity(v) {
5255
if (!v) return;
5356
const x = v.toLowerCase();
54-
if (x.includes("crash") || x.includes("崩溃")) {
55-
labels.add("severity/crash");
57+
if (x.includes("critical") || x.includes("crash") || x.includes("严重") || x.includes("崩溃")) {
58+
labels.add("severity/critical");
5659
labels.add("priority/p0");
5760
return;
5861
}
@@ -61,8 +64,8 @@ jobs:
6164
labels.add("priority/p1");
6265
return;
6366
}
64-
if (x.includes("regression") || x.includes("回归")) {
65-
labels.add("severity/regression");
67+
if (x.includes("major") || x.includes("regression") || x.includes("主要") || x.includes("回归")) {
68+
labels.add("severity/major");
6669
labels.add("priority/p1");
6770
return;
6871
}

0 commit comments

Comments
 (0)