Skip to content

Commit df303da

Browse files
authored
Update and rename documentation.md to documentation.yml
Added issue form for documentation.
1 parent d449710 commit df303da

File tree

2 files changed

+60
-22
lines changed

2 files changed

+60
-22
lines changed

.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

0 commit comments

Comments
 (0)