Skip to content

Commit fa50902

Browse files
authored
docs: create documentation-specific issue templates (#196)
1 parent 6e43c7d commit fa50902

3 files changed

Lines changed: 123 additions & 0 deletions

File tree

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: Report incorrect, outdated, or unclear documentation
3+
title: "[Bug]: "
4+
labels: ["bug"]
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 problem you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
15+
- type: dropdown
16+
id: issue-type
17+
attributes:
18+
label: Type of issue
19+
description: What type of documentation issue is this?
20+
options:
21+
- Incorrect information
22+
- Outdated content
23+
- Broken link
24+
- Missing information
25+
- Typo or grammatical error
26+
- Unclear or confusing explanation
27+
- Other
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: page-url
33+
attributes:
34+
label: Page URL
35+
description: Link to the documentation page with the issue
36+
placeholder: https://spicetify.app/docs/...
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: description
42+
attributes:
43+
label: Description
44+
description: Describe the issue with the documentation
45+
placeholder: |
46+
What is wrong or missing?
47+
What should it say instead?
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: suggested-fix
53+
attributes:
54+
label: Suggested fix
55+
description: If you have a suggestion for how to fix this, please describe it here
56+
placeholder: The documentation should say...
57+
validations:
58+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Spicetify Discord
4+
url: https://discord.gg/VnevqPp2Rr
5+
about: Get help from the community on Discord
6+
- name: Spicetify CLI Issues
7+
url: https://github.com/spicetify/cli/issues
8+
about: Report issues with Spicetify CLI (not documentation)
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Feature Request
2+
description: Suggest new documentation or improvements
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing request for this?
10+
description: Please search to see if a similar request already exists.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
15+
- type: dropdown
16+
id: request-type
17+
attributes:
18+
label: Type of request
19+
description: What type of documentation improvement are you suggesting?
20+
options:
21+
- New documentation page
22+
- Expand existing documentation
23+
- Add examples or code snippets
24+
- Add images or diagrams
25+
- Improve navigation or organization
26+
- Translation
27+
- Other
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: related-page
33+
attributes:
34+
label: Related page (if applicable)
35+
description: Link to an existing documentation page this relates to
36+
placeholder: https://spicetify.app/docs/...
37+
validations:
38+
required: false
39+
40+
- type: textarea
41+
id: description
42+
attributes:
43+
label: Description
44+
description: Describe the documentation you'd like to see
45+
placeholder: |
46+
What topic should be covered?
47+
Why would this be helpful?
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: additional-context
53+
attributes:
54+
label: Additional context
55+
description: Any other context, examples, or references that might help
56+
validations:
57+
required: false

0 commit comments

Comments
 (0)