Skip to content

Commit ff88a01

Browse files
Ethan-ArrowoodEthan-Arrowood
authored
Merge pull request #236 from HarperDB/more-issue-templates
add more issue templates
2 parents 412eeb5 + a537aef commit ff88a01

File tree

5 files changed

+423
-24
lines changed

5 files changed

+423
-24
lines changed

‎.github/ISSUE_TEMPLATE/content-issue.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: 📝 Content Issue
2+
description: Report problems with existing documentation content (typos, errors, confusing sections, outdated information)
3+
title: '[Content Issue]: '
4+
labels: ['content', 'bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve our documentation! Use this template to report issues with existing content such as typos, errors, confusing sections, or outdated information.
10+
11+
For platform/site functionality issues, please use the "Platform Bug" template instead.
12+
13+
- type: dropdown
14+
id: issue-type
15+
attributes:
16+
label: Issue Type
17+
description: What kind of content issue is this?
18+
options:
19+
- Incorrect information
20+
- Missing information
21+
- Confusing/unclear content
22+
- Typo or formatting error
23+
- Outdated information
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: content-location
30+
attributes:
31+
label: Content Location
32+
description: URL or section where the issue is located. Make sure to include the version number too.
33+
placeholder: "https://docs.harperdb.io/docs/getting-started/#harper-basics or '(4.6) Getting Started > Harper Basics'"
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: issue-description
39+
attributes:
40+
label: What's wrong?
41+
description: Describe the issue with the current content
42+
placeholder: "Be as specific as possible about what's incorrect, missing, or confusing"
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: suggested-improvement
48+
attributes:
49+
label: Suggested improvement
50+
description: How would you improve this content? (optional)
51+
placeholder: 'What would make this clearer or more accurate?'
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional context
57+
description: Any other context that might be helpful
58+
placeholder: 'Screenshots, related issues, etc.'
59+
60+
- type: dropdown
61+
id: contribution-intent
62+
attributes:
63+
label: Are you planning to fix this issue?
64+
description: Let us know if you'd like to contribute the fix!
65+
options:
66+
- "Yes, I'll submit a PR to fix this"
67+
- "Yes, but I'm a first-time contributor and could use guidance"
68+
- 'Maybe, depending on complexity'
69+
- 'No, just reporting the issue'
70+
validations:
71+
required: true
72+
73+
- type: checkboxes
74+
id: first-time-contributor
75+
attributes:
76+
label: First-time contributor support
77+
description: Check any that apply (only if you're planning to contribute)
78+
options:
79+
- label: I'm new to contributing and would appreciate guidance on the process
80+
- label: I'd like help understanding the project structure
81+
- label: I need assistance with setting up the development environment
82+
- label: I'm comfortable contributing but new to this project specifically

‎.github/ISSUE_TEMPLATE/content-request.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: 📚 Content Request
2+
description: Request new documentation or coverage for undocumented features, APIs, or functionality
3+
title: '[Content Request]: '
4+
labels: ['content', 'enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us identify documentation gaps! Use this template to request new documentation for undocumented features, missing API coverage, or other content needs.
10+
11+
For platform/site feature requests, please use the "Platform Feature Request" template instead.
12+
13+
- type: dropdown
14+
id: request-type
15+
attributes:
16+
label: Request Type
17+
description: What kind of documentation is needed?
18+
options:
19+
- Undocumented existing feature
20+
- New feature documentation
21+
- API/method documentation
22+
- Tutorial or guide
23+
- Code examples
24+
- Missing section coverage
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: what-needs-documenting
31+
attributes:
32+
label: What needs to be documented?
33+
description: Describe what functionality, feature, or topic needs documentation
34+
placeholder: "Be specific about what's missing or undocumented"
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: suggested-location
40+
attributes:
41+
label: Where should this be documented?
42+
description: Suggest where in the docs this content should live
43+
placeholder: 'New section, existing page URL, or general area'
44+
45+
- type: textarea
46+
id: use-case
47+
attributes:
48+
label: Why is this needed?
49+
description: What use case or problem would this documentation solve?
50+
placeholder: 'How would this help users? What are people trying to accomplish?'
51+
52+
- type: textarea
53+
id: existing-information
54+
attributes:
55+
label: Existing information
56+
description: Do you have any information, examples, or resources that could help?
57+
placeholder: 'Code snippets, API responses, screenshots, links to related features, etc.'
58+
59+
- type: dropdown
60+
id: priority
61+
attributes:
62+
label: Priority/Impact
63+
description: How important is this documentation gap?
64+
options:
65+
- 'High - critical for user success'
66+
- 'Medium - important but not urgent'
67+
- 'Low - nice to have'
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: contribution-intent
73+
attributes:
74+
label: Are you planning to fix this issue?
75+
description: Let us know if you'd like to contribute the fix!
76+
options:
77+
- "Yes, I'll submit a PR to fix this"
78+
- "Yes, but I'm a first-time contributor and could use guidance"
79+
- 'Maybe, depending on complexity'
80+
- 'No, just reporting the issue'
81+
validations:
82+
required: true
83+
84+
- type: checkboxes
85+
id: first-time-contributor
86+
attributes:
87+
label: First-time contributor support
88+
description: Check any that apply (only if you're planning to contribute)
89+
options:
90+
- label: I'm new to contributing and would appreciate guidance on the process
91+
- label: I'd like help understanding the project structure
92+
- label: I need assistance with setting up the development environment
93+
- label: I'm comfortable contributing but new to this project specifically

‎.github/ISSUE_TEMPLATE/documentation-content-error.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/platform-bug.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: 🐛 Platform Bug
2+
description: Report issues with the documentation site's functionality (broken features, UI problems, performance issues)
3+
title: '[Platform Bug]: '
4+
labels: ['platform', 'bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a platform issue! Use this template for problems with the site's functionality such as broken search, navigation issues, mobile problems, or performance issues.
10+
11+
For content-related issues (typos, errors, confusing text), please use the "Content Issue" template instead.
12+
13+
- type: input
14+
id: bug-summary
15+
attributes:
16+
label: Bug Summary
17+
description: Brief summary of the issue
18+
placeholder: "Search doesn't work on mobile, navigation menu broken, etc."
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: steps-to-reproduce
24+
attributes:
25+
label: Steps to Reproduce
26+
description: How can we reproduce this issue?
27+
placeholder: |
28+
1. Go to '...'
29+
2. Click on '...'
30+
3. Scroll down to '...'
31+
4. See error
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: expected-behavior
37+
attributes:
38+
label: Expected Behavior
39+
description: What should happen?
40+
placeholder: 'What did you expect to happen?'
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: actual-behavior
46+
attributes:
47+
label: Actual Behavior
48+
description: What actually happened?
49+
placeholder: 'What actually happened instead?'
50+
validations:
51+
required: true
52+
53+
- type: input
54+
id: url
55+
attributes:
56+
label: Page URL
57+
description: Where did this issue occur?
58+
placeholder: 'https://docs.example.com/page'
59+
60+
- type: dropdown
61+
id: browsers
62+
attributes:
63+
label: Browser
64+
description: Which browser are you using?
65+
multiple: true
66+
options:
67+
- Chrome
68+
- Firefox
69+
- Safari
70+
- Edge
71+
- Mobile Safari (iOS)
72+
- Chrome Mobile (Android)
73+
- Other
74+
75+
- type: input
76+
id: device
77+
attributes:
78+
label: Device/OS
79+
description: What device and operating system?
80+
placeholder: 'Windows 11, macOS 14, iPhone 15, etc.'
81+
82+
- type: textarea
83+
id: console-errors
84+
attributes:
85+
label: Console Errors
86+
description: Any console errors or network issues? (Check browser dev tools)
87+
placeholder: 'Copy/paste any error messages from the browser console'
88+
89+
- type: textarea
90+
id: screenshots
91+
attributes:
92+
label: Screenshots or Videos
93+
description: Add screenshots or videos to help explain the problem
94+
placeholder: 'Drag and drop images here or paste URLs'
95+
96+
- type: textarea
97+
id: additional-context
98+
attributes:
99+
label: Additional Context
100+
description: Any other relevant information
101+
placeholder: 'Frequency of issue, workarounds, related issues, etc.'
102+
103+
- type: dropdown
104+
id: contribution-intent
105+
attributes:
106+
label: Are you planning to fix this issue?
107+
description: Let us know if you'd like to contribute the fix!
108+
options:
109+
- "Yes, I'll submit a PR to fix this"
110+
- "Yes, but I'm a first-time contributor and could use guidance"
111+
- 'Maybe, depending on complexity'
112+
- 'No, just reporting the issue'
113+
validations:
114+
required: true
115+
116+
- type: checkboxes
117+
id: first-time-contributor
118+
attributes:
119+
label: First-time contributor support
120+
description: Check any that apply (only if you're planning to contribute)
121+
options:
122+
- label: I'm new to contributing and would appreciate guidance on the process
123+
- label: I'd like help understanding the project structure
124+
- label: I need assistance with setting up the development environment
125+
- label: I'm comfortable contributing but new to this project specifically

0 commit comments

Comments
 (0)