Skip to content

Commit c418248

Browse files
authored
Create documentation_update.yml
Made this 'documentation_update" template and added an issue form to make it easier for the contributor to raise it.
1 parent e87c19c commit c418248

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: 📝 Documentation Update
2+
description: Improve Documentation
3+
title: "[Documentation Update]: "
4+
body:
5+
- type: checkboxes
6+
id: existing-issue
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the updates you want to make.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
id: issue-description
15+
attributes:
16+
label: Issue Description
17+
description: Please provide a clear description of the documentation update you are suggesting.
18+
placeholder: Describe the improvement or correction you'd like to see in the documentation.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: suggested-change
23+
attributes:
24+
label: Suggested Change
25+
description: Provide details of the proposed change to the documentation.
26+
placeholder: Explain how the documentation should be updated or corrected.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: rationale
31+
attributes:
32+
label: Rationale
33+
description: Why is this documentation update necessary or beneficial?
34+
placeholder: Explain the importance or reasoning behind the suggested change.
35+
validations:
36+
required: False
37+
- type: dropdown
38+
id: urgency
39+
attributes:
40+
label: Urgency
41+
description: How urgently do you believe this documentation update is needed?
42+
options:
43+
- High
44+
- Medium
45+
- Low
46+
default: 0
47+
validations:
48+
required: true
49+
- type: checkboxes
50+
id: terms
51+
attributes:
52+
label: Record
53+
options:
54+
- label: "I agree to follow this project's Code of Conduct"
55+
required: true
56+
- label: "I'm a GSSOC contributor"
57+
required: False
58+
- label: "I want to work on this issue"
59+
required: False
60+
- label: "I'm willing to provide further clarification or assistance if needed."
61+
required: False

0 commit comments

Comments
 (0)