Skip to content

Commit 76e8830

Browse files
authored
Merge pull request #284 from TonyStark-47/issue_templates
[FEAT]: Created Issue forms and made the issue options more visually appealing
2 parents d176188 + 74c0e5d commit 76e8830

File tree

6 files changed

+178
-50
lines changed

6 files changed

+178
-50
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug report 🐞
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: bug
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: what-happened
16+
attributes:
17+
label: Describe the bug
18+
description: A concise description of what you are experiencing.
19+
placeholder: Tell us what you see!
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: expected-behaviour
24+
attributes:
25+
label: Expected behavior
26+
description: A clear and concise description of what you expected to happen.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: screenshots
31+
attributes:
32+
label: Add ScreenShots
33+
description: Add sufficient ScreenShots to explain your issue.
34+
- type: dropdown
35+
id: devices
36+
attributes:
37+
label: On which device are you experiencing this bug?
38+
multiple: true
39+
options:
40+
- Android
41+
- iPhone
42+
- Linux
43+
- Chrome
44+
- Windows
45+
- type: checkboxes
46+
id: terms
47+
attributes:
48+
label: Record
49+
options:
50+
- label: "I have read the Contributing Guidelines"
51+
required: true
52+
- label: "I'm a GSSOC'24 contributor"
53+
required: False
54+
- label: "I have starred the repository"
55+
required: true

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 📝 Documentation Update
2+
description: Improve Documentation
3+
title: "[Documentation Update]: "
4+
labels: 'enhancement'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the updates you want to make.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: issue-description
16+
attributes:
17+
label: Issue Description
18+
description: Please provide a clear description of the documentation update you are suggesting.
19+
placeholder: Describe the improvement or correction you'd like to see in the documentation.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: suggested-change
24+
attributes:
25+
label: Suggested Change
26+
description: Provide details of the proposed change to the documentation.
27+
placeholder: Explain how the documentation should be updated or corrected.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: rationale
32+
attributes:
33+
label: Rationale
34+
description: Why is this documentation update necessary or beneficial?
35+
placeholder: Explain the importance or reasoning behind the suggested change.
36+
validations:
37+
required: False
38+
- type: dropdown
39+
id: urgency
40+
attributes:
41+
label: Urgency
42+
description: How urgently do you believe this documentation update is needed?
43+
options:
44+
- High
45+
- Medium
46+
- Low
47+
default: 0
48+
validations:
49+
required: true
50+
- type: checkboxes
51+
id: terms
52+
attributes:
53+
label: Record
54+
options:
55+
- label: "I have read the Contributing Guidelines"
56+
required: true
57+
- label: "I'm a GSSOC'24 contributor"
58+
required: false
59+
- label: "I have starred the repository"
60+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: ✨ Feature Request
2+
description: Suggest a feature
3+
title: "[Feature Request]: "
4+
labels: enhancement
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for this feature.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: feature-description
16+
attributes:
17+
label: Feature Description
18+
description: Please provide a detailed description of the feature you are requesting.
19+
placeholder: Describe the new feature or enhancement you'd like to see.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: use-case
24+
attributes:
25+
label: Use Case
26+
description: How would this feature enhance your use of the project?
27+
placeholder: Describe a specific use case or scenario where this feature would be beneficial.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: benefits
32+
attributes:
33+
label: Benefits
34+
description: What benefits would this feature bring to the project or community?
35+
placeholder: Explain the advantages of implementing this feature.
36+
- type: textarea
37+
id: screenShots
38+
attributes:
39+
label: Add ScreenShots
40+
description: If any...
41+
- type: dropdown
42+
id: priority
43+
attributes:
44+
label: Priority
45+
description: How important is this feature to you?
46+
options:
47+
- High
48+
- Medium
49+
- Low
50+
default: 0
51+
validations:
52+
required: true
53+
- type: checkboxes
54+
id: terms
55+
attributes:
56+
label: Record
57+
options:
58+
- label: "I have read the Contributing Guidelines"
59+
required: true
60+
- label: "I'm a GSSOC'24 contributor"
61+
required: false
62+
- label: "I have starred the repository"
63+
required: true

0 commit comments

Comments
 (0)