Update issue templates #703
Open
+106
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In preparation for open preview, let's start with some basic templates.
aimurphy
reviewed
Dec 22, 2025
Collaborator
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
I think you're still working on these, but I left some thoughts.
| title: '' | ||
| labels: bug | ||
| assignees: '' | ||
|
|
|
|
||
| --- | ||
|
|
||
| **Describe the bug** |
Collaborator
There was a problem hiding this comment.
Suggested change
| **Describe the bug** | |
| ## Describe the bug |
Can these be headings? It is more accessible to use headings than bold styling.
Comment on lines
+26
to
+35
| **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] |
Collaborator
There was a problem hiding this comment.
Suggested change
| **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] | |
| ## Environment | |
| If this occurred on a desktop, provide the following information: | |
| - OS: [e.g. macOS Sequoia] | |
| - Browser: [e.g. Google Chrome, Apple Safari] | |
| - Version: [e.g. 22] | |
| If this occurred on a smartphone or tablet, provide the following information: | |
| - Device: [e.g. iPhone 15] | |
| - OS: [e.g. iOS 26.0] | |
| - Browser: [e.g. Google Chrome, Apple Safari] | |
| - Version: [e.g. 22] |
|
|
||
| ## Type of documentation issue | ||
|
|
||
| <!-- What kind of documentation issue is this? Please select one --> |
Collaborator
There was a problem hiding this comment.
Suggested change
| <!-- What kind of documentation issue is this? Please select one --> | |
| What kind of documentation issue are you reporting? |
Comment on lines
+23
to
+26
| <!-- Where is the documentation issue located? --> | ||
| <!-- e.g., README.md line 42, docs/getting-started.md, API reference for function X --> | ||
|
|
||
| **Location:** |
Collaborator
There was a problem hiding this comment.
Suggested change
| <!-- Where is the documentation issue located? --> | |
| <!-- e.g., README.md line 42, docs/getting-started.md, API reference for function X --> | |
| **Location:** | |
| Provide the link or file name where you discovered the issue, such as `README.md line 42`, `install.mdx`, or `API reference for <endpoint>`. |
Not sure why these ones are in comments instead of plain text.
| --- | ||
|
|
||
| **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.
Suggested change
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | |
| A clear and concise description of what the problem is. | |
| For example, `It's difficult to do <task>` or `I want to integrate with <service>`. |
| - Version [e.g. 22] | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. |
Collaborator
There was a problem hiding this comment.
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
Collaborator
|
@CharnaParkey I hope the following PR helps: #728 I just saw this PR after creating the above PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In preparation for open preview, let's start with some basic templates.