-
Notifications
You must be signed in to change notification settings - Fork 18
Update issue templates #703
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||
| name: Bug report | ||||||||||||||||||||||||||||||||||||||||||||||||||
| about: Create a report to help us improve | ||||||||||||||||||||||||||||||||||||||||||||||||||
| title: '' | ||||||||||||||||||||||||||||||||||||||||||||||||||
| labels: bug | ||||||||||||||||||||||||||||||||||||||||||||||||||
| assignees: '' | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Describe the bug** | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Can these be headings? It is more accessible to use headings than bold styling. |
||||||||||||||||||||||||||||||||||||||||||||||||||
| A clear and concise description of what the bug is. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **To Reproduce** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Steps to reproduce the behavior: | ||||||||||||||||||||||||||||||||||||||||||||||||||
| 1. Go to '...' | ||||||||||||||||||||||||||||||||||||||||||||||||||
| 2. Click on '....' | ||||||||||||||||||||||||||||||||||||||||||||||||||
| 3. Scroll down to '....' | ||||||||||||||||||||||||||||||||||||||||||||||||||
| 4. See error | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Expected behavior** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| A clear and concise description of what you expected to happen. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Screenshots** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| If applicable, add screenshots to help explain your problem. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Desktop (please complete the following information):** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - OS: [e.g. iOS] | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - Browser [e.g. chrome, safari] | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - Version [e.g. 22] | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Smartphone (please complete the following information):** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - Device: [e.g. iPhone6] | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - OS: [e.g. iOS8.1] | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - Browser [e.g. stock browser, safari] | ||||||||||||||||||||||||||||||||||||||||||||||||||
| - Version [e.g. 22] | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+26
to
+35
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| **Additional context** | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Add any other context about the problem here. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You might want to suggest that they leave scrubbed logs, if they are willing to share them. You could also link to the community guidelines and tips for more info: https://docs.openr.ag/support/contribute#community-guidelines-and-tips |
||||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,48 @@ | ||||||||||||||
| --- | ||||||||||||||
| name: Documentation | ||||||||||||||
| about: Report an issue with documentation or suggest improvements | ||||||||||||||
| title: "[DOCS]" | ||||||||||||||
| labels: documentation | ||||||||||||||
| assignees: '' | ||||||||||||||
|
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ## Type of documentation issue | ||||||||||||||
|
|
||||||||||||||
| <!-- What kind of documentation issue is this? Please select one --> | ||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| - [ ] Missing documentation | ||||||||||||||
| - [ ] Incorrect/outdated documentation | ||||||||||||||
| - [ ] Unclear documentation | ||||||||||||||
| - [ ] Typo or grammar issue | ||||||||||||||
| - [ ] Example code doesn't work | ||||||||||||||
| - [ ] Other | ||||||||||||||
|
|
||||||||||||||
| ## Location | ||||||||||||||
|
|
||||||||||||||
| <!-- Where is the documentation issue located? --> | ||||||||||||||
| <!-- e.g., README.md line 42, docs/getting-started.md, API reference for function X --> | ||||||||||||||
|
|
||||||||||||||
| **Location:** | ||||||||||||||
|
Comment on lines
+23
to
+26
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Not sure why these ones are in comments instead of plain text. |
||||||||||||||
|
|
||||||||||||||
| ## Describe the issue | ||||||||||||||
|
|
||||||||||||||
| <!-- What's wrong with the current documentation? --> | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Suggested improvement | ||||||||||||||
|
|
||||||||||||||
| <!-- How should the documentation be improved? --> | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Additional context | ||||||||||||||
|
|
||||||||||||||
| <!-- Add any other context about the documentation issue here --> | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Contribution | ||||||||||||||
|
|
||||||||||||||
| - [ ] I'd be willing to submit a PR to fix this documentation issue | ||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,20 @@ | ||||||||
| --- | ||||||||
| name: Feature request | ||||||||
| about: Suggest an idea for this project | ||||||||
| title: '' | ||||||||
| labels: enhancement | ||||||||
| assignees: '' | ||||||||
|
|
||||||||
| --- | ||||||||
|
|
||||||||
| **Is your feature request related to a problem? Please describe.** | ||||||||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
|
||||||||
| **Describe the solution you'd like** | ||||||||
| A clear and concise description of what you want to happen. | ||||||||
|
|
||||||||
| **Describe alternatives you've considered** | ||||||||
| A clear and concise description of any alternative solutions or features you've considered. | ||||||||
|
|
||||||||
| **Additional context** | ||||||||
| Add any other context or screenshots about the feature request here. | ||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blank line intended?