Skip to content

Commit 6d7cfa3

Browse files
authored
Merge pull request #39 from PMDevSolutions/17-create-issue-templates-for-bug-reports-and-feature-requests
docs: add standardized GitHub issue templates
2 parents 1ed9591 + fee9f84 commit 6d7cfa3

4 files changed

Lines changed: 440 additions & 23 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 95 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,69 @@
11
name: Bug Report
22
description: Report a bug or unexpected behavior
33
title: "[Bug]: "
4-
labels: ["bug"]
4+
labels: ["bug", "triage"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to report a bug! Please fill out the form below.
9+
Thanks for taking the time to report a bug! Please fill out the form below with as much detail as possible.
10+
11+
- type: dropdown
12+
id: severity
13+
attributes:
14+
label: Severity
15+
description: How severe is the impact of this bug?
16+
options:
17+
- Critical (System crash, data loss, security issue)
18+
- High (Major feature broken, no workaround)
19+
- Medium (Feature partially broken, workaround exists)
20+
- Low (Minor issue, cosmetic, edge case)
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: component
26+
attributes:
27+
label: Affected Component
28+
description: Which part of the framework is affected?
29+
options:
30+
- Agents (Custom Claude Code agents)
31+
- Skills (Slash command skills)
32+
- Scripts (Development automation scripts)
33+
- Pipeline - Figma-to-React
34+
- Pipeline - Canva-to-React
35+
- Pipeline - Screenshot-to-App
36+
- Templates (Starter configs)
37+
- MCP Integration (Figma, Playwright, Chrome DevTools)
38+
- Documentation
39+
- Other
40+
validations:
41+
required: true
1042

1143
- type: textarea
1244
id: description
1345
attributes:
14-
label: Description
46+
label: Bug Description
1547
description: A clear and concise description of the bug.
16-
placeholder: Describe the bug...
48+
placeholder: Describe what went wrong...
1749
validations:
1850
required: true
1951

2052
- type: textarea
2153
id: steps-to-reproduce
2254
attributes:
2355
label: Steps to Reproduce
24-
description: Steps to reproduce the behavior.
56+
description: Detailed steps to reproduce the behavior.
57+
value: |
58+
1.
59+
2.
60+
3.
61+
4.
2562
placeholder: |
26-
1. Run '...'
27-
2. Open '...'
28-
3. See error
63+
1. Run command '...'
64+
2. Open file '...'
65+
3. Execute '...'
66+
4. Observe error...
2967
validations:
3068
required: true
3169

@@ -34,24 +72,35 @@ body:
3472
attributes:
3573
label: Expected Behavior
3674
description: What you expected to happen.
37-
placeholder: Describe the expected behavior...
75+
placeholder: I expected...
3876
validations:
3977
required: true
4078

4179
- type: textarea
4280
id: actual-behavior
4381
attributes:
4482
label: Actual Behavior
45-
description: What actually happened.
46-
placeholder: Describe what actually happened...
83+
description: What actually happened instead.
84+
placeholder: Instead, what happened was...
4785
validations:
4886
required: true
4987

88+
- type: textarea
89+
id: error-logs
90+
attributes:
91+
label: Error Logs / Stack Trace
92+
description: Paste any relevant error messages, logs, or stack traces.
93+
render: shell
94+
placeholder: |
95+
Paste error output here...
96+
validations:
97+
required: false
98+
5099
- type: input
51100
id: os
52101
attributes:
53102
label: Operating System
54-
description: e.g. Windows 11, macOS 14.3, Ubuntu 22.04
103+
description: e.g., Windows 11, macOS 14.3, Ubuntu 22.04
55104
placeholder: Windows 11
56105
validations:
57106
required: true
@@ -74,11 +123,42 @@ body:
74123
validations:
75124
required: true
76125

126+
- type: input
127+
id: claude-code-version
128+
attributes:
129+
label: Claude Code Version (if applicable)
130+
description: Output of `claude --version`
131+
placeholder: claude-code v1.0.0
132+
validations:
133+
required: false
134+
77135
- type: textarea
78136
id: screenshots
79137
attributes:
80-
label: Screenshots
81-
description: If applicable, add screenshots to help explain the problem. Drag and drop images here.
82-
placeholder: Drag and drop screenshots here...
138+
label: Screenshots / Recordings
139+
description: If applicable, add screenshots or screen recordings to help explain the problem.
140+
placeholder: Drag and drop images or videos here...
83141
validations:
84142
required: false
143+
144+
- type: textarea
145+
id: additional-context
146+
attributes:
147+
label: Additional Context
148+
description: Any other context, configuration files, or related information.
149+
placeholder: Additional details...
150+
validations:
151+
required: false
152+
153+
- type: checkboxes
154+
id: checklist
155+
attributes:
156+
label: Pre-submission Checklist
157+
description: Please confirm the following before submitting.
158+
options:
159+
- label: I have searched existing issues to ensure this bug hasn't been reported already.
160+
required: true
161+
- label: I have provided all the requested information above.
162+
required: true
163+
- label: I am using the latest version of the framework.
164+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@ contact_links:
33
- name: Questions & Discussions
44
url: https://github.com/PMDevSolutions/Aurelius/discussions
55
about: Ask questions and discuss ideas in GitHub Discussions
6+
7+
- name: Documentation
8+
url: https://github.com/PMDevSolutions/Aurelius/tree/main/docs
9+
about: Check the documentation before opening an issue
10+
11+
- name: Security Vulnerabilities
12+
url: https://github.com/PMDevSolutions/Aurelius/security/advisories/new
13+
about: Report security vulnerabilities privately via GitHub Security Advisories
Lines changed: 104 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,50 @@
11
name: Feature Request
22
description: Suggest a new feature or improvement
33
title: "[Feature]: "
4-
labels: ["enhancement"]
4+
labels: ["enhancement", "triage"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for suggesting a feature! Please fill out the form below.
9+
Thanks for suggesting a feature! Please fill out the form below to help us understand your request.
10+
11+
- type: dropdown
12+
id: feature-type
13+
attributes:
14+
label: Feature Type
15+
description: What type of feature is this?
16+
options:
17+
- New Feature (Something that doesn't exist yet)
18+
- Enhancement (Improve existing functionality)
19+
- Integration (Add support for new tool/service)
20+
- Developer Experience (Improve workflow/usability)
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: target-component
26+
attributes:
27+
label: Target Component
28+
description: Which part of the framework would this feature affect?
29+
options:
30+
- Agents (Custom Claude Code agents)
31+
- Skills (Slash command skills)
32+
- Scripts (Development automation scripts)
33+
- Pipeline - Figma-to-React
34+
- Pipeline - Canva-to-React
35+
- Pipeline - Screenshot-to-App
36+
- Templates (Starter configs)
37+
- MCP Integration (Figma, Playwright, Chrome DevTools)
38+
- Documentation
39+
- Multiple Components
40+
- New Component
41+
validations:
42+
required: true
1043

1144
- type: textarea
1245
id: description
1346
attributes:
14-
label: Description
47+
label: Feature Description
1548
description: A clear and concise description of the feature you'd like.
1649
placeholder: Describe the feature...
1750
validations:
@@ -21,25 +54,88 @@ body:
2154
id: use-case
2255
attributes:
2356
label: Use Case
24-
description: Describe the problem this feature would solve or the use case it enables.
25-
placeholder: I want this feature because...
57+
description: Describe the problem this feature would solve or the use case it enables. Help us understand the "why" behind this request.
58+
placeholder: |
59+
As a [type of user], I want to [do something] so that [benefit/value].
60+
61+
Currently, I have to... which is problematic because...
2662
validations:
2763
required: true
2864

2965
- type: textarea
3066
id: proposed-solution
3167
attributes:
3268
label: Proposed Solution
33-
description: Describe how you'd like this feature to work.
34-
placeholder: The feature should...
69+
description: Describe how you'd like this feature to work. Be as specific as possible.
70+
placeholder: |
71+
The feature should:
72+
1. ...
73+
2. ...
74+
3. ...
3575
validations:
3676
required: true
3777

3878
- type: textarea
3979
id: alternatives
4080
attributes:
4181
label: Alternatives Considered
42-
description: Describe any alternative solutions or workarounds you've considered.
82+
description: Describe any alternative solutions, workarounds, or approaches you've considered.
4383
placeholder: I've also considered...
4484
validations:
4585
required: false
86+
87+
- type: dropdown
88+
id: scope
89+
attributes:
90+
label: Scope / Effort Estimate
91+
description: How big of a change do you think this would be? (Your best guess)
92+
options:
93+
- Small (Minor change, few files)
94+
- Medium (Moderate change, multiple files/components)
95+
- Large (Significant change, new system/major refactor)
96+
- Unknown (Not sure)
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
id: acceptance-criteria
102+
attributes:
103+
label: Acceptance Criteria
104+
description: What would need to be true for this feature to be considered complete?
105+
placeholder: |
106+
- [ ] Criterion 1
107+
- [ ] Criterion 2
108+
- [ ] Criterion 3
109+
validations:
110+
required: false
111+
112+
- type: textarea
113+
id: additional-context
114+
attributes:
115+
label: Additional Context
116+
description: Add any other context, mockups, examples, or references about the feature request.
117+
placeholder: Additional context, links, or screenshots...
118+
validations:
119+
required: false
120+
121+
- type: checkboxes
122+
id: contribution
123+
attributes:
124+
label: Contribution Interest
125+
description: Would you be interested in contributing to this feature?
126+
options:
127+
- label: I would be willing to submit a PR for this feature
128+
required: false
129+
- label: I would be willing to help test this feature
130+
required: false
131+
132+
- type: checkboxes
133+
id: checklist
134+
attributes:
135+
label: Pre-submission Checklist
136+
description: Please confirm the following before submitting.
137+
options:
138+
- label: I have searched existing issues and discussions to ensure this hasn't been requested already.
139+
required: true
140+
- label: I have read the project documentation and this feature is not already available.
141+
required: true

0 commit comments

Comments
 (0)