-
Notifications
You must be signed in to change notification settings - Fork 34
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 #314 from souvikpramanikgit/adding
Adding Enhancement Request, Documentation Update template
- Loading branch information
Showing
2 changed files
with
131 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,65 @@ | ||
name: π Documentation Update | ||
description: Improve Documentation | ||
title: "[Doc]: " | ||
labels: [documentation] | ||
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: Acknowledgements | ||
description: Ensure you have read and agree to the project's guidelines. | ||
options: | ||
- label: I'm a GSSOC'24-Extd contributor | ||
- label: I'm a Hacktoberfest contributor | ||
- label: 'I am willing to work on this issue (optional)' | ||
required: false | ||
|
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,66 @@ | ||
name: Enhancement Request π§βπ» | ||
description: Submit your enhancement requests for review. | ||
title: 'π§βπ»: ' | ||
labels: ["Up-for-Grabs β", "enhancement π§βπ»"] | ||
assignees: | ||
- '' | ||
|
||
body: | ||
- type: textarea | ||
id: enhancement-title | ||
attributes: | ||
label: Title | ||
placeholder: Enter the title of your enhancement request here. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: enhancement-aim | ||
attributes: | ||
label: Enhancement Aim | ||
placeholder: Describe the aim of the enhancement. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: changes | ||
attributes: | ||
label: Changes | ||
placeholder: Enlist those changes you want to make. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Screenshots π· | ||
placeholder: Write N/A if not available. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: full-name | ||
attributes: | ||
label: Full Name | ||
placeholder: Enter your full name here. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: participant-role | ||
attributes: | ||
label: Participant Role | ||
placeholder: Enter your participant role here (e.g., GSSOC, Hacktoberfest). | ||
validations: | ||
required: true | ||
|
||
|
||
- type: checkboxes | ||
id: guidelines | ||
attributes: | ||
label: Guidelines | ||
options: | ||
- label: "I have read the guidelines" | ||
required: true | ||
- label: "I have the link to my latest merged PR" | ||
required: false |