chore: improve GitHub issue templates (#5700)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
2ccb98a6cb
commit
1bfd121d7d
3 changed files with 77 additions and 51 deletions
81
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
81
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,46 +1,66 @@
|
||||||
name: Bug Report
|
name: Bug Report
|
||||||
description: If something isn't working as expected
|
description: Something isn't working as expected
|
||||||
labels: [bug]
|
labels: [bug]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thank you for taking the time to report a bug! Please complete the form below to help us understand and fix the issue.
|
Thanks for reporting a bug! Please fill out the form below so we can reproduce and fix the issue.
|
||||||
|
|
||||||
|
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates.
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: pre-check
|
id: pre-check
|
||||||
attributes:
|
attributes:
|
||||||
label: Pre-submission Checklist
|
label: Pre-submission Checklist
|
||||||
description: Please confirm you have completed the following steps before submitting
|
|
||||||
options:
|
options:
|
||||||
- label: I have searched the existing issues and this bug has not been reported yet
|
- label: I have searched existing issues and confirmed this bug has not been reported
|
||||||
required: true
|
required: true
|
||||||
- label: I have tested this issue on the [demo site](https://demo.usememos.com) or the latest version
|
- label: I can reproduce this bug on the latest version or the [demo site](https://demo.usememos.com)
|
||||||
|
required: true
|
||||||
|
- label: This is a bug, not a question (use [Discussions](https://github.com/usememos/memos/discussions) for questions)
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: issue-location
|
|
||||||
attributes:
|
|
||||||
label: Where did you encounter this bug?
|
|
||||||
description: Select where you tested and confirmed this issue
|
|
||||||
options:
|
|
||||||
- Latest stable version (self-hosted)
|
|
||||||
- Latest development version (self-hosted)
|
|
||||||
- Demo site (demo.usememos.com)
|
|
||||||
- Older version (please specify below)
|
|
||||||
default: 0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
id: version
|
id: version
|
||||||
attributes:
|
attributes:
|
||||||
label: Memos Version
|
label: Memos Version
|
||||||
description: Provide the exact version (e.g., `v0.25.2`). Find this in Settings → About or via `--version` flag
|
description: Find this in **Settings > System > About** or via the `--version` flag
|
||||||
placeholder: v0.25.2
|
placeholder: "v0.25.2"
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: deployment
|
||||||
|
attributes:
|
||||||
|
label: Deployment Method
|
||||||
|
options:
|
||||||
|
- Docker
|
||||||
|
- Pre-built binary
|
||||||
|
- Built from source
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: database
|
||||||
|
attributes:
|
||||||
|
label: Database
|
||||||
|
options:
|
||||||
|
- SQLite
|
||||||
|
- PostgreSQL
|
||||||
|
- MySQL
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: browser-os
|
||||||
|
attributes:
|
||||||
|
label: Browser & OS
|
||||||
|
description: e.g. Chrome 120 on macOS 15, Firefox 130 on Ubuntu 24.04
|
||||||
|
placeholder: "Chrome 120 on macOS 15"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: bug-description
|
id: bug-description
|
||||||
attributes:
|
attributes:
|
||||||
|
|
@ -54,12 +74,11 @@ body:
|
||||||
id: reproduction-steps
|
id: reproduction-steps
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to Reproduce
|
label: Steps to Reproduce
|
||||||
description: Detailed steps to reproduce the behavior
|
description: Minimal steps to reliably reproduce the issue
|
||||||
placeholder: |
|
placeholder: |
|
||||||
1. Go to '...'
|
1. Go to '...'
|
||||||
2. Click on '...'
|
2. Click on '...'
|
||||||
3. Scroll down to '...'
|
3. See error
|
||||||
4. See error
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -67,16 +86,14 @@ body:
|
||||||
id: expected-behavior
|
id: expected-behavior
|
||||||
attributes:
|
attributes:
|
||||||
label: Expected Behavior
|
label: Expected Behavior
|
||||||
description: What did you expect to happen?
|
description: What did you expect to happen instead?
|
||||||
placeholder: I expected...
|
placeholder: I expected...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Screenshots & Additional Context
|
label: Screenshots, Logs & Additional Context
|
||||||
description: Add screenshots, browser/OS info, deployment method (Docker/binary), or any other relevant details
|
description: Attach screenshots, browser console errors, or server logs if available
|
||||||
placeholder: |
|
placeholder: Drag and drop images here, or paste error logs...
|
||||||
- Browser: Chrome 120
|
|
||||||
- OS: macOS 14
|
|
||||||
- Deployment: Docker
|
|
||||||
- Database: SQLite
|
|
||||||
|
|
|
||||||
7
.github/ISSUE_TEMPLATE/config.yml
vendored
7
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1 +1,8 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Questions & Support
|
||||||
|
url: https://github.com/usememos/memos/discussions
|
||||||
|
about: Ask questions or get help in GitHub Discussions — please don't open issues for questions
|
||||||
|
- name: Documentation
|
||||||
|
url: https://www.usememos.com/docs
|
||||||
|
about: Check the documentation before opening an issue
|
||||||
|
|
|
||||||
40
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
40
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,36 +1,36 @@
|
||||||
name: Feature Request
|
name: Feature Request
|
||||||
description: If you have a suggestion for a new feature
|
description: Suggest a new feature or improvement
|
||||||
labels: [enhancement]
|
labels: [enhancement]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thank you for suggesting a new feature! Please complete the form below to help us understand your idea.
|
Thanks for suggesting a feature! Please fill out the form below so we can understand your idea.
|
||||||
|
|
||||||
|
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues?q=label%3Aenhancement) to avoid duplicates.
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: pre-check
|
id: pre-check
|
||||||
attributes:
|
attributes:
|
||||||
label: Pre-submission Checklist
|
label: Pre-submission Checklist
|
||||||
description: Please confirm you have completed the following steps before submitting
|
|
||||||
options:
|
options:
|
||||||
- label: I have searched the existing issues and this feature has not been requested yet
|
- label: I have searched existing issues and confirmed this feature has not been requested
|
||||||
|
required: true
|
||||||
|
- label: This is a feature request, not a bug report or question
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
id: feature-type
|
id: feature-type
|
||||||
attributes:
|
attributes:
|
||||||
label: Type of Feature
|
label: Feature Area
|
||||||
description: What type of feature is this?
|
|
||||||
options:
|
options:
|
||||||
- User Interface (UI)
|
- User Interface (UI)
|
||||||
- User Experience (UX)
|
- User Experience (UX)
|
||||||
- API / Backend
|
- API / Backend
|
||||||
- Documentation
|
|
||||||
- Integrations / Plugins
|
- Integrations / Plugins
|
||||||
- Security / Privacy
|
- Security / Privacy
|
||||||
- Performance
|
- Performance
|
||||||
- Other
|
- Other
|
||||||
default: 0
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -38,10 +38,9 @@ body:
|
||||||
id: problem-statement
|
id: problem-statement
|
||||||
attributes:
|
attributes:
|
||||||
label: Problem or Use Case
|
label: Problem or Use Case
|
||||||
description: What problem does this feature solve? What are you trying to accomplish?
|
description: What problem does this feature solve? Why do you need it?
|
||||||
placeholder: |
|
placeholder: |
|
||||||
I often need to... but currently there's no way to...
|
I often need to... but currently there's no way to...
|
||||||
This would help me/users to...
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -49,10 +48,9 @@ body:
|
||||||
id: proposed-solution
|
id: proposed-solution
|
||||||
attributes:
|
attributes:
|
||||||
label: Proposed Solution
|
label: Proposed Solution
|
||||||
description: A clear and concise description of what you want to happen
|
description: Describe what you'd like to happen
|
||||||
placeholder: |
|
placeholder: |
|
||||||
It would be great if Memos could...
|
It would be great if Memos could...
|
||||||
For example, a button/feature that...
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -60,17 +58,21 @@ body:
|
||||||
id: alternatives
|
id: alternatives
|
||||||
attributes:
|
attributes:
|
||||||
label: Alternatives Considered
|
label: Alternatives Considered
|
||||||
description: Have you considered any alternative solutions or workarounds?
|
description: Have you considered any workarounds or alternative approaches?
|
||||||
placeholder: |
|
placeholder: |
|
||||||
I've tried... but it doesn't work well because...
|
I've tried... but it doesn't work well because...
|
||||||
An alternative could be...
|
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional Context
|
label: Additional Context
|
||||||
description: Add any other context, mockups, screenshots, or examples about the feature request
|
description: Mockups, screenshots, examples from other apps, or any other context
|
||||||
placeholder: |
|
placeholder: Drag and drop images here...
|
||||||
- Similar feature in other apps: ...
|
|
||||||
- Mockups or screenshots: ...
|
- type: checkboxes
|
||||||
- Related discussions: ...
|
id: contribution
|
||||||
|
attributes:
|
||||||
|
label: Contribution
|
||||||
|
description: Would you be willing to help implement this feature?
|
||||||
|
options:
|
||||||
|
- label: I'm willing to submit a pull request for this feature
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue