Skip to content

Commit 6ea3cfe

Browse files
committed
cicd: attempt at documenting labels to choices
1 parent 005d5e7 commit 6ea3cfe

File tree

4 files changed

+94
-4
lines changed

4 files changed

+94
-4
lines changed

.github/ISSUE_TEMPLATE/01_bug_report.yml

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,38 @@
11
name: '🐛 Bug Report'
22
description: Report a bug with the template or generated projects
3-
labels: [bug]
3+
labels: [bug, needs-triage]
44
title: '[Bug] '
55

6+
# Label Mapping Documentation for GitHub Actions:
7+
#
8+
# Scope mapping (based on issue_scope field):
9+
# - "Template (generation, hooks, template scripts)" → scope:template
10+
# - "Generated Project (nox, dependencies, tooling)" → scope:generated
11+
#
12+
# Component mapping (based on issue_category field):
13+
# - "Template - Nox commands" → component:nox
14+
# - "Template - Post-generation hooks" → component:hooks
15+
# - "*Rust extension*" → rust
16+
# - "*CI/CD*" → component:ci
17+
# - "*Container/Docker*" → component:container
18+
# - "*Documentation*" → documentation (remove from primary)
19+
# - "*Testing*" → component:testing
20+
# - "*Security*" → component:security
21+
# - "*Dependency*" → dependencies (add as primary)
22+
#
23+
# Priority mapping (based on severity field):
24+
# - "Critical (blocks all usage)" → priority:critical
25+
# - "High (blocks major functionality)" → priority:high
26+
# - "Medium (workaround available)" → priority:medium
27+
# - "Low (minor inconvenience)" → priority:low
28+
#
29+
# Environment mapping (when relevant):
30+
# - python_version: "3.9" → python:3.9, etc.
31+
# - os: "macOS*" → os:macos, "Linux*" → os:linux, "Windows*" → os:windows, "WSL*" → os:wsl
32+
#
33+
# Feature flags:
34+
# - rust_extension: "Yes" → rust
35+
636
body:
737
- type: markdown
838
attributes:

.github/ISSUE_TEMPLATE/02_feature_request.yml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,35 @@
11
name: '✨ Feature Request'
22
description: Suggest new features or improvements for the template or generated projects
3-
labels: [enhancement]
3+
labels: [enhancement, needs-triage]
44
title: '[Feature] '
55

6+
# Label Mapping Documentation for GitHub Actions:
7+
#
8+
# Scope mapping (based on feature_scope field):
9+
# - "Template (cookiecutter options, generation process)" → scope:template
10+
# - "Generated Project (nox sessions, tooling, structure)" → scope:generated
11+
# - "Both" → scope:both
12+
#
13+
# Component mapping (based on feature_category field):
14+
# - "*nox*" → component:nox
15+
# - "*hooks*" → component:hooks
16+
# - "*Rust*" → rust
17+
# - "*CI/CD*" → component:ci
18+
# - "*Container*" → component:container
19+
# - "*Documentation*" → documentation (add as primary)
20+
# - "*Testing*" → component:testing
21+
# - "*Security*" → component:security
22+
# - "*Dependency*" → dependencies (add as primary)
23+
#
24+
# Priority mapping (based on priority field):
25+
# - "Critical" → priority:critical
26+
# - "Important" → priority:high
27+
# - "Nice to have" → priority:medium
28+
#
29+
# Feature flags:
30+
# - rust_impact: "Yes*" → rust
31+
# - breaking_change: "Yes - Requires migration" → breaking-change
32+
633
body:
734
- type: markdown
835
attributes:

.github/ISSUE_TEMPLATE/03_documentation.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
name: '📖 Documentation Issue'
22
description: Report documentation issues or suggest improvements
3-
labels: [documentation]
3+
labels: [documentation, needs-triage]
44
title: '[Docs] '
55

6+
# Label Mapping Documentation for GitHub Actions:
7+
#
8+
# Scope mapping (based on doc_scope field):
9+
# - "Template (this repository)" → scope:template
10+
# - "Generated Project (documentation templates)" → scope:generated
11+
# - "Both" → scope:both
12+
#
13+
# Priority mapping (based on priority field):
14+
# - "Critical - Incorrect information" → priority:critical
15+
# - "High - Blocks understanding" → priority:high
16+
# - "Medium - Affects usability" → priority:medium
17+
# - "Low - Minor improvement" → priority:low
18+
#
19+
# Feature flags:
20+
# - affects_rust: "Yes*" → rust
21+
622
body:
723
- type: markdown
824
attributes:

.github/ISSUE_TEMPLATE/04_dependency_update.yml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
name: '📦 Dependency Update'
22
description: Suggest updates to dependencies, tools, or versions
3-
labels: [dependencies, maintenance]
3+
labels: [dependencies, needs-triage]
44
title: '[Dependency] '
55

6+
# Label Mapping Documentation for GitHub Actions:
7+
#
8+
# Scope mapping (based on update_scope field):
9+
# - "Template only" → scope:template
10+
# - "Generated projects only" → scope:generated
11+
# - "Both template and generated projects" → scope:both
12+
#
13+
# Priority mapping (based on urgency field):
14+
# - "Critical - Security vulnerability" → priority:critical
15+
# - "High - Breaks functionality" → priority:high
16+
# - "Medium - Improvement needed" → priority:medium
17+
# - "Low - Nice to have" → priority:low
18+
#
19+
# Feature flags:
20+
# - affects_rust: "Yes*" → rust
21+
# - breaking_change: "Major - Significant changes required" → breaking-change
22+
623
body:
724
- type: markdown
825
attributes:

0 commit comments

Comments
 (0)