Skip to content

Commit d9d6262

Browse files
tomshawtomshaw
committed
feat: add new issue templates for bug reports, documentation issues, feature requests, general issues, improvements, and questions
- Introduced structured templates to enhance issue reporting and tracking. - Each template includes fields for summary, detailed descriptions, and additional context to streamline the process for users.
1 parent 27aab95 commit d9d6262

7 files changed

Lines changed: 329 additions & 11 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug Report
2+
description: Report a bug, crash, or unexpected behavior.
3+
title: "[BUG]: "
4+
labels: ["bug", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Brief one-liner describing the bug. This appears in the issue list preview."
13+
placeholder: "Login form crashes when submitting invalid credentials."
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: steps
19+
attributes:
20+
label: 🔁 Steps to Reproduce
21+
description: "Clearly describe how to reproduce the issue."
22+
placeholder: |
23+
1. Go to /login
24+
2. Enter invalid credentials
25+
3. Click Submit
26+
4. See error
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: actual_behavior
32+
attributes:
33+
label: ❌ Actual Behavior
34+
description: "What happens instead of the expected behavior?"
35+
placeholder: "The app returns a 500 server error."
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: expected_behavior
41+
attributes:
42+
label: ✅ Expected Behavior
43+
description: "What should happen instead?"
44+
placeholder: "It should show a validation error message."
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: logs
50+
attributes:
51+
label: 📄 Logs / Screenshots
52+
description: "Add error logs, screenshots, or videos if possible."
53+
placeholder: "Paste logs or screenshots here."
54+
validations:
55+
required: false
56+
57+
- type: input
58+
id: environment
59+
attributes:
60+
label: 🌐 Environment
61+
description: "OS, browser, app version, DB version, etc."
62+
placeholder: "Windows 11, Chrome 125, Laravel v10.30"
63+
validations:
64+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1 @@
1-
blank_issues_enabled: false
2-
contact_links:
3-
- name: Ask a Question
4-
url: https://github.com/tomshaw/electricgrid/discussions/new?category=q-a
5-
about: Ask the community for help
6-
- name: Feature Request
7-
url: https://github.com/tomshaw/electricgrid/discussions/new?category=ideas
8-
about: Share ideas for new features
9-
- name: Bug Report
10-
url: https://github.com/tomshaw/electricgrid/issues/new
11-
about: Report a reproducable bug
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Documentation Issue
2+
description: Report missing, outdated, or unclear documentation.
3+
title: "[DOCS]: "
4+
labels: ["documentation", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Brief summary of the documentation issue. This appears in the issue list preview."
13+
placeholder: "Missing example for API authentication."
14+
validations:
15+
required: true
16+
17+
- type: input
18+
id: page_or_section
19+
attributes:
20+
label: 📄 Affected Page or Section
21+
description: "Which documentation page, URL, or section does this relate to?"
22+
placeholder: "/docs/authentication"
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: ❌ Issue Description
30+
description: "Describe what is missing, outdated, or unclear."
31+
placeholder: "The documentation does not show how to generate an API token."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: suggested_change
37+
attributes:
38+
label: ✅ Suggested Fix or Update
39+
description: "Propose how the documentation could be improved."
40+
placeholder: "Add an example curl command showing how to get an API token."
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: additional_context
46+
attributes:
47+
label: 💬 Additional Context
48+
description: "Any other notes, screenshots, or references?"
49+
placeholder: "Add additional context"
50+
validations:
51+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature Request
2+
description: Suggest a new feature or capability.
3+
title: "[FEATURE]: "
4+
labels: ["enhancement", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Short summary of the feature request. This shows in the issue list preview."
13+
placeholder: "Add a dark mode toggle in the header."
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: problem
19+
attributes:
20+
label: ❓ Problem / Use Case
21+
description: "What problem does this feature solve?"
22+
placeholder: "Users find the bright theme difficult to use at night."
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed_solution
28+
attributes:
29+
label: 💡 Proposed Solution
30+
description: "Describe how you would like it implemented."
31+
placeholder: "Add a toggle button in the navbar to switch between dark and light themes."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: 🔄 Alternatives Considered
39+
description: "Have you considered other solutions or workarounds?"
40+
placeholder: "Users can use browser plugins, but it's not ideal."
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: additional_context
46+
attributes:
47+
label: 💬 Additional Context
48+
description: "Any other details, screenshots, or references?"
49+
placeholder: "Figma designs, competitor apps, etc."
50+
validations:
51+
required: false

‎.github/ISSUE_TEMPLATE/general_issue.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: General Issue
2+
description: File a bug, feature request, or improvement. Please include a meaningful summary.
3+
title: "[ISSUE]: "
4+
labels: ["triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Briefly describe the issue in 1–2 sentences. This will appear in the issue list preview."
13+
placeholder: "Login form crashes when submitting invalid credentials"
14+
validations:
15+
required: true
16+
17+
- type: dropdown
18+
id: issue_type
19+
attributes:
20+
label: 🧩 Type of Issue
21+
description: "What kind of issue is this?"
22+
options:
23+
- Bug
24+
- Feature Request
25+
- Improvement
26+
- Question / Help
27+
- Other
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: module
33+
attributes:
34+
label: 🗂️ Related Service / Module
35+
description: "Which part of the system is this about? (e.g., MaterialService, Proposals)"
36+
placeholder: "AuthService"
37+
validations:
38+
required: false
39+
40+
- type: textarea
41+
id: description
42+
attributes:
43+
label: 📝 Detailed Description
44+
description: "Provide a clear explanation of the issue or request. Include what is currently happening and what should happen instead."
45+
placeholder: "When submitting invalid credentials, the app crashes with a 500 error. It should return a validation error."
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: reproduction
51+
attributes:
52+
label: 🔁 Steps to Reproduce (if applicable)
53+
description: "Only for bugs — include clear steps, screenshots, or logs."
54+
placeholder: |
55+
1. Go to /login
56+
2. Enter invalid credentials
57+
3. Click Submit
58+
4. See error
59+
validations:
60+
required: false
61+
62+
- type: textarea
63+
id: additional_context
64+
attributes:
65+
label: 💡 Additional Context
66+
description: "Add any other info: environment, OS, browser, logs, etc."
67+
placeholder: "Windows 11, Chrome 125, Laravel v10.30"
68+
validations:
69+
required: false

‎.github/ISSUE_TEMPLATE/improvement.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Improvement
2+
description: Propose an improvement to existing functionality.
3+
title: "[IMPROVEMENT]: "
4+
labels: ["enhancement", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Short description of the improvement. This appears in the issue list preview."
13+
placeholder: "Optimize the dashboard load time."
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: current_behavior
19+
attributes:
20+
label: ❌ Current Behavior
21+
description: "What is the current limitation or issue?"
22+
placeholder: "Dashboard takes ~5 seconds to load data."
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed_change
28+
attributes:
29+
label: ✅ Proposed Change
30+
description: "Describe the improvement you would like to see."
31+
placeholder: "Implement data caching to reduce load time."
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: benefits
37+
attributes:
38+
label: 🚀 Benefits
39+
description: "How would this change help users or maintainers?"
40+
placeholder: "Improved user experience and reduced server load."
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: additional_context
46+
attributes:
47+
label: 💬 Additional Context
48+
description: "Any other notes, screenshots, or examples?"
49+
placeholder: "Add additional context"
50+
validations:
51+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Question / Help
2+
description: Ask a question or get clarification about the project.
3+
title: "[QUESTION]: "
4+
labels: ["question", "triage"]
5+
assignees: []
6+
7+
body:
8+
- type: input
9+
id: summary
10+
attributes:
11+
label: 📌 Summary
12+
description: "Short summary of your question. This appears in the issue list preview."
13+
placeholder: "How to configure the API client for custom domains?"
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: question_details
19+
attributes:
20+
label: ❓ Details
21+
description: "Describe your question, what you’re trying to do, and where you’re stuck."
22+
placeholder: "I’m trying to connect to the API with a custom domain, but getting a 403 error."
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: tried
28+
attributes:
29+
label: 🛠️ What have you tried?
30+
description: "List any docs, code, or troubleshooting you’ve done so far."
31+
placeholder: "Checked the README, tried setting the API_BASE_URL variable, etc."
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: additional_context
37+
attributes:
38+
label: 💬 Additional Context
39+
description: "Any other information, screenshots, or logs?"
40+
placeholder: "Add additional context"
41+
validations:
42+
required: false

0 commit comments

Comments
 (0)