feat: add issue templates for bug reports and feature requests
- Add bug_report.yml template with plugin-specific fields - Add feature_request.yml template for enhancement suggestions - Add config.yml to customize issue creation experience - Templates help standardize issue reporting and improve triage
This commit is contained in:
141
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
141
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
name: 🐛 Bug Report
|
||||||
|
description: Report a bug or issue with OpenWebUI plugins
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: ["bug"]
|
||||||
|
assignees: []
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this bug report! Please provide clear information to help us understand and resolve the issue.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: plugin-type
|
||||||
|
attributes:
|
||||||
|
label: Plugin Type
|
||||||
|
description: Which type of plugin is affected?
|
||||||
|
options:
|
||||||
|
- Action
|
||||||
|
- Filter
|
||||||
|
- Pipe
|
||||||
|
- Pipeline
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: plugin-name
|
||||||
|
attributes:
|
||||||
|
label: Plugin Name
|
||||||
|
description: Which plugin has the issue?
|
||||||
|
placeholder: "e.g., Smart Mind Map, Export to Word"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Clearly describe the bug or issue you encountered
|
||||||
|
placeholder: |
|
||||||
|
What happened? What did you expect to happen?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: How can we reproduce the issue?
|
||||||
|
placeholder: |
|
||||||
|
1. Go to...
|
||||||
|
2. Click on...
|
||||||
|
3. See error...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: What should happen instead?
|
||||||
|
placeholder: "The plugin should..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: actual
|
||||||
|
attributes:
|
||||||
|
label: Actual Behavior
|
||||||
|
description: What is actually happening?
|
||||||
|
placeholder: "Instead, the plugin..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: openwebui-version
|
||||||
|
attributes:
|
||||||
|
label: OpenWebUI Version
|
||||||
|
description: What version of OpenWebUI are you using?
|
||||||
|
placeholder: "e.g., 0.3.0 or main"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: browser
|
||||||
|
attributes:
|
||||||
|
label: Browser
|
||||||
|
description: What browser are you using?
|
||||||
|
options:
|
||||||
|
- Chrome
|
||||||
|
- Firefox
|
||||||
|
- Safari
|
||||||
|
- Edge
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: browser-console
|
||||||
|
attributes:
|
||||||
|
label: Browser Console Output
|
||||||
|
description: "Any errors shown in the browser developer console? (Press F12)"
|
||||||
|
placeholder: "Paste console errors or warnings here"
|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: plugin-config
|
||||||
|
attributes:
|
||||||
|
label: Plugin Configuration
|
||||||
|
description: "If applicable, share your plugin valve settings (remove sensitive data)"
|
||||||
|
placeholder: |
|
||||||
|
SHOW_STATUS: true
|
||||||
|
SHOW_DEBUG_LOG: false
|
||||||
|
...
|
||||||
|
render: python
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional
|
||||||
|
attributes:
|
||||||
|
label: Additional Context
|
||||||
|
description: Any other information that might help?
|
||||||
|
placeholder: "Screenshots, logs, or other relevant details..."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: checklist
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
options:
|
||||||
|
- label: I have searched existing issues for duplicates
|
||||||
|
required: true
|
||||||
|
- label: I have provided clear steps to reproduce the issue
|
||||||
|
required: true
|
||||||
|
- label: I have mentioned the plugin name and OpenWebUI version
|
||||||
|
required: true
|
||||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Documentation
|
||||||
|
url: https://docs.openwebui.com/
|
||||||
|
about: Official OpenWebUI documentation
|
||||||
|
- name: Discussions
|
||||||
|
url: https://github.com/Fu-Jie/openwebui-extensions/discussions
|
||||||
|
about: Ask questions and discuss with the community
|
||||||
|
- name: OpenWebUI Repository
|
||||||
|
url: https://github.com/open-webui/open-webui
|
||||||
|
about: Main OpenWebUI project
|
||||||
87
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
87
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
name: ✨ Feature Request
|
||||||
|
description: Suggest a new feature or improvement
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
assignees: []
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for your idea! Please describe the feature you'd like to see.
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: plugin-type
|
||||||
|
attributes:
|
||||||
|
label: Plugin Type (Optional)
|
||||||
|
description: Is this for a specific plugin type?
|
||||||
|
options:
|
||||||
|
- Action
|
||||||
|
- Filter
|
||||||
|
- Pipe
|
||||||
|
- Pipeline
|
||||||
|
- Core/General
|
||||||
|
- Documentation
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: plugin-name
|
||||||
|
attributes:
|
||||||
|
label: Plugin Name (Optional)
|
||||||
|
description: Which plugin would benefit from this feature?
|
||||||
|
placeholder: "e.g., Smart Mind Map"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Feature Description
|
||||||
|
description: Clearly describe the feature you're requesting
|
||||||
|
placeholder: |
|
||||||
|
What feature would you like to see? Why would it be useful?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: motivation
|
||||||
|
attributes:
|
||||||
|
label: Motivation
|
||||||
|
description: Why is this feature important to you?
|
||||||
|
placeholder: |
|
||||||
|
What problem does this solve?
|
||||||
|
How would it improve the user experience?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Alternatives Considered
|
||||||
|
description: Any other approaches you've thought of?
|
||||||
|
placeholder: |
|
||||||
|
Have you considered other solutions?
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional
|
||||||
|
attributes:
|
||||||
|
label: Additional Context
|
||||||
|
description: Mockups, references, or examples?
|
||||||
|
placeholder: |
|
||||||
|
Links, screenshots, or code examples...
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: checklist
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
options:
|
||||||
|
- label: I have searched existing issues/discussions for similar requests
|
||||||
|
required: true
|
||||||
|
- label: This feature would be useful for multiple users
|
||||||
|
required: false
|
||||||
Reference in New Issue
Block a user