Skip to content

Commit 13b6244

Browse files
committed
✨ feat: overhaul issue and pull request templates for improved clarity and usability
1 parent d5b21ec commit 13b6244

File tree

17 files changed

+547
-100
lines changed

17 files changed

+547
-100
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
type: Bug
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report for the Chase project! Please provide as much detail as possible to help us identify and fix the issue.
10+
11+
- type: textarea
12+
id: bug-description
13+
attributes:
14+
label: Describe the bug
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Tell us what happened!
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction-steps
22+
attributes:
23+
label: Steps to reproduce
24+
description: Please provide detailed steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. Scroll down to '...'
29+
4. See error
30+
31+
- type: textarea
32+
id: expected-behavior
33+
attributes:
34+
label: Expected behavior
35+
description: A clear and concise description of what you expected to happen.
36+
placeholder: What should have happened instead?
37+
38+
- type: textarea
39+
id: screenshots
40+
attributes:
41+
label: Screenshots
42+
description: If applicable, add screenshots to help explain your problem.
43+
placeholder: Drag and drop screenshots here or click to upload.
44+
45+
- type: dropdown
46+
id: severity
47+
attributes:
48+
label: Severity
49+
description: Please estimate the severity of this bug so we can triage appropriately
50+
options:
51+
- Critical (Breaks core functionality)
52+
- High (Significantly impacts user experience)
53+
- Medium (Noticeable issue but workaround exists)
54+
- Low (Minor issue or cosmetic)
55+
validations:
56+
required: true
57+
58+
- type: dropdown
59+
id: browser
60+
attributes:
61+
label: Browser
62+
description: Which browser are you using?
63+
options:
64+
- Chrome
65+
- Firefox
66+
- Safari
67+
- Edge
68+
- Other (please specify in additional context)
69+
validations:
70+
required: true
71+
72+
- type: dropdown
73+
id: component
74+
attributes:
75+
label: Component
76+
description: Which part of the Chase project does this bug affect?
77+
options:
78+
- Frontend
79+
- Backend
80+
- API
81+
- Database
82+
- Infrastructure
83+
- Documentation
84+
- Other (please specify in additional context)
85+
validations:
86+
required: true
87+
88+
- type: input
89+
id: browser-version
90+
attributes:
91+
label: Browser Version
92+
description: What version of the browser are you using?
93+
placeholder: e.g., 120.0.6099.109
94+
95+
- type: dropdown
96+
id: operating-system
97+
attributes:
98+
label: Operating System
99+
description: What operating system are you using?
100+
options:
101+
- Windows
102+
- macOS
103+
- Linux
104+
- iOS
105+
- Android
106+
- Other (please specify in additional context)
107+
validations:
108+
required: true
109+
110+
- type: dropdown
111+
id: device-type
112+
attributes:
113+
label: Device Type
114+
description: What type of device are you using?
115+
options:
116+
- Desktop
117+
- Laptop
118+
- Tablet
119+
- Mobile Phone
120+
- Other
121+
validations:
122+
required: true
123+
124+
- type: textarea
125+
id: additional-context
126+
attributes:
127+
label: Additional context
128+
description: Add any other context about the problem here, including console errors, network conditions, or anything else that might be relevant.
129+
placeholder: Any additional information that might help us understand the issue...

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
blank_issues_enabled: true
1+
blank_issues_enabled: false
22
contact_links:
3-
- name: Ask a question or recieve help
3+
- name: Ask a question or receive help
44
url: https://github.com/deutschemodelunitednations/munify-chase/discussions/categories/support
5-
about: Please use the help tab of the discussion section to recieve help and ask questions.
5+
about: Please use the help tab of the discussion section to receive help and ask questions.
6+
- name: Suggest a feature or enhancement
7+
url: https://github.com/deutschemodelunitednations/munify-chase/discussions/categories/feature-requests
8+
about: Please use the feature request tab of the discussion section to suggest new features or enhancements.
9+
- name: General Discussion
10+
url: https://github.com/deutschemodelunitednations/munify-chase/discussions
11+
about: For general discussions about the project that don't fit into a specific issue template.

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Documentation Issue
2+
description: Report an error, problem, or suggestion for our documentation
3+
tags: ['documentation']
4+
type: Task
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping us improve our documentation! Please provide details about the documentation issue you've found.
11+
12+
- type: dropdown
13+
id: doc-type
14+
attributes:
15+
label: Documentation Type
16+
description: What type of documentation issue is this?
17+
options:
18+
- Error/Correction (Something is wrong or outdated)
19+
- Missing Information (Something important is not documented)
20+
- Improvement Suggestion (Documentation could be clearer or better organized)
21+
- New Documentation Request (Need docs for a new feature or process)
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
id: doc-location
27+
attributes:
28+
label: Documentation Location
29+
description: Where is this documentation located?
30+
options:
31+
- GitHub README
32+
- GitHub Wiki
33+
- Project Website
34+
- Code Comments/Inline Documentation
35+
- API Documentation
36+
- User Guide/Manual
37+
- Developer Documentation
38+
- Other (please specify below)
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: doc-url
44+
attributes:
45+
label: Documentation URL or File Path
46+
description: Please provide the URL or file path of the documentation in question
47+
placeholder: https://example.com/docs or /path/to/file.md
48+
49+
- type: textarea
50+
id: issue-description
51+
attributes:
52+
label: Issue Description
53+
description: Describe what you want to be changed in our documentation
54+
placeholder: Clearly explain what's wrong, missing, or could be improved...
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: current-content
60+
attributes:
61+
label: Current Content (if applicable)
62+
description: If reporting an error, please include the current incorrect content
63+
placeholder: Copy and paste the current documentation that needs to be fixed...
64+
65+
- type: textarea
66+
id: suggested-content
67+
attributes:
68+
label: Suggested Content
69+
description: If you have a suggestion for how to fix or improve the documentation, please include it here
70+
placeholder: Provide your suggested changes or new content...
71+
72+
- type: dropdown
73+
id: audience
74+
attributes:
75+
label: Target Audience
76+
description: Who is the primary audience for this documentation?
77+
options:
78+
- End Users (Delegates/Participants)
79+
- Administrators (Conference Organizers)
80+
- Developers (Contributors)
81+
- All Users
82+
- Other (please specify in additional context)
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: additional-context
88+
attributes:
89+
label: Additional Context
90+
description: Add any other context, examples, or references that might help us understand the documentation issue
91+
placeholder: Any additional information that might help us improve the documentation...

.github/ISSUE_TEMPLATE/enhancement.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)