-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Create documentation_update.yml
Added issue form for the documentation update in .yml format
1 parent
a7e102e
commit 7ca617c
Showing
1 changed file
with
59 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,59 @@ | ||
name: 📝 Documentation Update | ||
description: Improve Documentation | ||
title: "[Documentation Update]: " | ||
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: true | ||
- label: "I have starred the repository" | ||
required: true |