Skip to content

Commit 09df676

Browse files
committed
cicd: greatly simplify the issue templates in favor of having users add labels manually
1 parent 6ea3cfe commit 09df676

File tree

4 files changed

+89
-541
lines changed

4 files changed

+89
-541
lines changed
Lines changed: 24 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,39 @@
11
name: '🐛 Bug Report'
22
description: Report a bug with the template or generated projects
3-
labels: [bug, needs-triage]
3+
labels: [bug]
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-
366
body:
377
- type: markdown
388
attributes:
399
value: |
40-
## Bug Report
41-
42-
Report issues with either the cookiecutter template or generated projects.
10+
Thanks for taking the time to report a bug! Please provide as much detail as possible.
4311
4412
- type: dropdown
4513
id: issue_scope
4614
attributes:
47-
label: 🎯 Issue Scope
48-
description: Is this a template issue or generated project issue?
15+
label: Is this a template issue or generated project issue?
4916
options:
50-
- Template (generation, hooks, template scripts)
17+
- Template (generation, hooks, scripts)
5118
- Generated Project (nox, dependencies, tooling)
5219
validations:
5320
required: true
5421

5522
- type: textarea
5623
id: description
5724
attributes:
58-
label: 📝 Bug Description
59-
description: Clearly describe what went wrong
25+
label: Bug Description
26+
description: A clear and concise description of the bug
6027
placeholder: |
61-
A clear and concise description of the bug...
62-
validations:
63-
required: true
64-
65-
- type: dropdown
66-
id: issue_category
67-
attributes:
68-
label: 🏷️ Issue Category
69-
description: Select the category that best describes the issue
70-
options:
71-
# Template-specific options
72-
- Template - Cookiecutter prompts/input
73-
- Template - File generation
74-
- Template - Post-generation hooks
75-
- Template - Nox commands (generate-demo, lint, test)
76-
- Template - Documentation/structure
77-
# Generated project options
78-
- Generated - Nox session failures
79-
- Generated - Dependency/package management
80-
- Generated - Build/packaging problems
81-
- Generated - Testing framework issues
82-
- Generated - Documentation build issues
83-
- Generated - Linting/formatting configuration
84-
- Generated - Type checking issues
85-
- Generated - Security scanning problems
86-
- Generated - CI/CD workflow issues
87-
- Generated - Rust extension issues
88-
- Generated - Container/Docker issues
89-
- Generated - Project structure/files
90-
- Other
28+
What went wrong? Please be as specific as possible.
9129
validations:
9230
required: true
9331

9432
- type: textarea
9533
id: reproduction
9634
attributes:
97-
label: 🔄 Steps to Reproduce
98-
description: Provide clear steps to reproduce the issue
35+
label: Steps to Reproduce
36+
description: How can we reproduce this issue?
9937
value: |
10038
1.
10139
2.
@@ -106,124 +44,45 @@ body:
10644
- type: textarea
10745
id: expected_behavior
10846
attributes:
109-
label: Expected Behavior
47+
label: Expected Behavior
11048
description: What did you expect to happen?
11149
validations:
11250
required: true
11351

11452
- type: textarea
11553
id: actual_behavior
11654
attributes:
117-
label: Actual Behavior
55+
label: Actual Behavior
11856
description: What actually happened?
11957
validations:
12058
required: true
12159

122-
- type: textarea
123-
id: cookiecutter_config
124-
attributes:
125-
label: ⚙️ Cookiecutter Configuration
126-
description: Paste your .cookiecutter.json file contents or the options you selected
127-
render: json
128-
placeholder: |
129-
{
130-
"project_name": "my-project",
131-
"add_rust_extension": "no",
132-
...
133-
}
134-
validations:
135-
required: false
136-
137-
- type: dropdown
138-
id: rust_extension
139-
attributes:
140-
label: 🦀 Rust Extension
141-
description: Does your project include Rust extensions?
142-
options:
143-
- "No"
144-
- "Yes"
145-
- "N/A - Template issue"
146-
validations:
147-
required: true
148-
149-
- type: dropdown
150-
id: python_version
151-
attributes:
152-
label: 🐍 Python Version
153-
description: Which Python version are you using?
154-
options:
155-
- "3.9"
156-
- "3.10"
157-
- "3.11"
158-
- "3.12"
159-
- "3.13"
160-
- "Other (specify in environment)"
161-
validations:
162-
required: true
163-
164-
- type: dropdown
165-
id: os
166-
attributes:
167-
label: 💻 Operating System
168-
description: Which OS are you using?
169-
options:
170-
- macOS (Intel)
171-
- macOS (Apple Silicon)
172-
- Linux (Ubuntu/Debian)
173-
- Linux (Fedora/RHEL)
174-
- Linux (Arch)
175-
- Linux (Other)
176-
- Windows 10
177-
- Windows 11
178-
- WSL2
179-
- Other
180-
validations:
181-
required: true
182-
18360
- type: textarea
18461
id: environment
18562
attributes:
186-
label: 🖥️ Environment Details
187-
description: Additional environment information
63+
label: Environment
64+
description: Please provide relevant environment details
18865
value: |
189-
- uv version:
190-
- nox version:
191-
- Cookiecutter version:
192-
- Template version/commit:
193-
- Other relevant tools:
66+
- OS:
67+
- Python version:
68+
- Cookiecutter version (if template issue):
69+
- Project configuration (rust extension enabled?):
19470
validations:
19571
required: true
19672

19773
- type: textarea
198-
id: error_output
74+
id: logs
19975
attributes:
200-
label: 🚨 Error Output
201-
description: Paste the complete error message, stack trace, or command output
76+
label: Relevant Logs/Output
77+
description: Please paste any relevant error messages or logs
20278
render: shell
203-
placeholder: |
204-
Paste full error output here...
20579
validations:
20680
required: false
20781

20882
- type: textarea
209-
id: workaround
83+
id: additional
21084
attributes:
211-
label: 🔧 Workaround
212-
description: If you found a temporary solution, please describe it
213-
placeholder: |
214-
Describe any workaround you discovered...
215-
validations:
216-
required: false
217-
218-
- type: dropdown
219-
id: severity
220-
attributes:
221-
label: ⚡ Severity
222-
description: How severe is this issue?
223-
options:
224-
- Critical (blocks all usage)
225-
- High (blocks major functionality)
226-
- Medium (workaround available)
227-
- Low (minor inconvenience)
85+
label: Additional Context
86+
description: Any other information that might be helpful
22887
validations:
229-
required: true
88+
required: false

0 commit comments

Comments
 (0)