Skip to content

Commit 740ab69

Browse files
authored
Create documentation_issue.yml
Signed-off-by: Christopher Jr Riley <chrisjr@cjrriley.com>
1 parent a473156 commit 740ab69

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Documentation Issue
2+
description: Report an inconsistency within the documentation (design issue, wording issue, spelling/grammar issue, etc.).
3+
title: "[Documentation]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thanks for taking the time to fill out this report! Please note that this form is for documentation issues only!
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: Summarize the issue in one or two sentences.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Description
21+
description: Explain in detail what the issue is.
22+
validations:
23+
required: true
24+
- type: dropdown
25+
id: issue-type
26+
attributes:
27+
label: What type of issue is it?
28+
multiple: true
29+
options:
30+
- Spelling
31+
- Grammar
32+
- Inconsistency
33+
- Suggestion
34+
- Error
35+
- Contradiction
36+
- Too much/Too Little
37+
- Outdated
38+
- Other
39+
validations:
40+
required: true
41+
- type: input
42+
id: atsyntaxtools-version
43+
attributes:
44+
label: ATSyntax Version
45+
description: State what version of ATSyntax you're using.
46+
validations:
47+
required: true
48+
- type: input
49+
id: doc-location
50+
attributes:
51+
label: Documentation Location
52+
description: State where you see the issue. It can be a URL link, the file path name, and/or the method/struct/property/etc.
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: Additional Context
59+
description: Add any other context about the issue here.

0 commit comments

Comments
 (0)