-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #84 from TonyStark-47/issue_template
[FEAT]: Created Issue forms and made the issue options more visually appealing
- Loading branch information
Showing
3 changed files
with
178 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
name: Bug report 🐞 | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: bug | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: Describe the bug | ||
description: A concise description of what you are experiencing. | ||
placeholder: Tell us what you see! | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behaviour | ||
attributes: | ||
label: Expected behavior | ||
description: A clear and concise description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Add ScreenShots | ||
description: Add sufficient ScreenShots to explain your issue. | ||
- type: dropdown | ||
id: devices | ||
attributes: | ||
label: On which device are you experiencing this bug? | ||
multiple: true | ||
options: | ||
- Android | ||
- iPhone | ||
- Linux | ||
- Chrome | ||
- Windows | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I have read the Contributing Guidelines" | ||
required: true | ||
- label: "I'm a GSSOC'24 contributor" | ||
required: False | ||
- label: "I have starred the repository" | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: 📝 Documentation Update | ||
description: Improve Documentation | ||
title: "[Documentation Update]: " | ||
labels: 'enhancement' | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the updates you want to make. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: issue-description | ||
attributes: | ||
label: Issue Description | ||
description: Please provide a clear description of the documentation update you are suggesting. | ||
placeholder: Describe the improvement or correction you'd like to see in the documentation. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-change | ||
attributes: | ||
label: Suggested Change | ||
description: Provide details of the proposed change to the documentation. | ||
placeholder: Explain how the documentation should be updated or corrected. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: rationale | ||
attributes: | ||
label: Rationale | ||
description: Why is this documentation update necessary or beneficial? | ||
placeholder: Explain the importance or reasoning behind the suggested change. | ||
validations: | ||
required: False | ||
- type: dropdown | ||
id: urgency | ||
attributes: | ||
label: Urgency | ||
description: How urgently do you believe this documentation update is needed? | ||
options: | ||
- High | ||
- Medium | ||
- Low | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I have read the Contributing Guidelines" | ||
required: true | ||
- label: "I'm a GSSOC'24 contributor" | ||
required: false | ||
- label: "I have starred the repository" | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: ✨ Feature Request | ||
description: Suggest a feature | ||
title: "[Feature Request]: " | ||
labels: enhancement | ||
body: | ||
- type: checkboxes | ||
id: existing-issue | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for this feature. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Feature Description | ||
description: Please provide a detailed description of the feature you are requesting. | ||
placeholder: Describe the new feature or enhancement you'd like to see. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: use-case | ||
attributes: | ||
label: Use Case | ||
description: How would this feature enhance your use of the project? | ||
placeholder: Describe a specific use case or scenario where this feature would be beneficial. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: benefits | ||
attributes: | ||
label: Benefits | ||
description: What benefits would this feature bring to the project or community? | ||
placeholder: Explain the advantages of implementing this feature. | ||
- type: textarea | ||
id: screenShots | ||
attributes: | ||
label: Add ScreenShots | ||
description: If any... | ||
- type: dropdown | ||
id: priority | ||
attributes: | ||
label: Priority | ||
description: How important is this feature to you? | ||
options: | ||
- High | ||
- Medium | ||
- Low | ||
default: 0 | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Record | ||
options: | ||
- label: "I have read the Contributing Guidelines" | ||
required: true | ||
- label: "I'm a GSSOC'24 contributor" | ||
required: false | ||
- label: "I have starred the repository" | ||
required: true |