Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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: ''

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blank line intended?

---

**Describe the bug**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Describe the bug**
## Describe the bug

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]


**Additional context**
Add any other context about the problem here.
Copy link
Collaborator

Choose a reason for hiding this comment

The 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

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
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 -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- What kind of documentation issue is this? Please select one -->
What kind of documentation issue are you reporting?


- [ ] 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## 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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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 [...]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>`.


**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.