Skip to content

Commit

Permalink
Update and rename documentation-update.md to documentation-update.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
apu52 authored Jun 15, 2024
1 parent 2b0567e commit 8e2efd2
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 23 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/documentation-update.md

This file was deleted.

62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
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'm a VSOC'24 contributor"
required: false
- label: "I have starred the repository"
required: true

0 comments on commit 8e2efd2

Please sign in to comment.