chore(github): simplify issue templates
This commit is contained in:
parent
ff6389a5ef
commit
587f5b1b6c
2 changed files with 54 additions and 86 deletions
89
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
89
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -5,7 +5,7 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for reporting a bug! Please fill out the form below so we can reproduce and fix the issue.
|
Thanks for reporting a bug. Please provide enough detail for maintainers to reproduce the issue.
|
||||||
|
|
||||||
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates.
|
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates.
|
||||||
|
|
||||||
|
|
@ -14,61 +14,31 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Pre-submission Checklist
|
label: Pre-submission Checklist
|
||||||
options:
|
options:
|
||||||
- label: I have searched existing issues and confirmed this bug has not been reported
|
- label: I have searched existing issues and confirmed this has not already been reported
|
||||||
required: true
|
required: true
|
||||||
- label: I can reproduce this bug on the latest version or the [demo site](https://demo.usememos.com)
|
- label: This is a bug report, not a question or configuration request
|
||||||
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: input
|
- type: input
|
||||||
id: version
|
id: version
|
||||||
attributes:
|
attributes:
|
||||||
label: Memos Version
|
label: Memos Version
|
||||||
description: Find this in **Settings > System > About** or via the `--version` flag
|
description: Use the version shown in **Settings > System**, the container image tag, the release binary version, or `memos --version`. Please do not write `latest` only.
|
||||||
placeholder: "v0.25.2"
|
placeholder: "v0.25.x, ghcr.io/usememos/memos:v0.25.x, main@abcdef, or demo site"
|
||||||
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: environment
|
||||||
attributes:
|
attributes:
|
||||||
label: Bug Description
|
label: Environment Details
|
||||||
description: A clear and concise description of what the bug is
|
description: Include anything relevant to where Memos is running.
|
||||||
placeholder: When I try to..., the application...
|
placeholder: |
|
||||||
validations:
|
- Deployment: Docker / binary / source / demo site
|
||||||
required: true
|
- Database: SQLite / PostgreSQL / MySQL
|
||||||
|
- Browser: Chrome 120 on macOS 15
|
||||||
|
- Server OS: Ubuntu 24.04
|
||||||
|
- Reverse proxy: nginx / Caddy / Traefik / none
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: reproduction-steps
|
id: reproduction-steps
|
||||||
|
|
@ -76,9 +46,19 @@ body:
|
||||||
label: Steps to Reproduce
|
label: Steps to Reproduce
|
||||||
description: Minimal steps to reliably reproduce the issue
|
description: Minimal steps to reliably reproduce the issue
|
||||||
placeholder: |
|
placeholder: |
|
||||||
1. Go to '...'
|
1. Go to ...
|
||||||
2. Click on '...'
|
2. Click ...
|
||||||
3. See error
|
3. Enter ...
|
||||||
|
4. See ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: current-behavior
|
||||||
|
attributes:
|
||||||
|
label: Current Behavior
|
||||||
|
description: What happened? Include exact error messages if available.
|
||||||
|
placeholder: The application ...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -91,9 +71,18 @@ body:
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Logs
|
||||||
|
description: Paste relevant server logs, browser console output, or network errors. Remove secrets before submitting.
|
||||||
|
render: shell
|
||||||
|
placeholder: |
|
||||||
|
Paste logs here.
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Screenshots, Logs & Additional Context
|
label: Additional Context
|
||||||
description: Attach screenshots, browser console errors, or server logs if available
|
description: Attach screenshots, screen recordings, sample data, or links to related issues.
|
||||||
placeholder: Drag and drop images here, or paste error logs...
|
placeholder: Drag and drop files here or add any extra context.
|
||||||
|
|
|
||||||
51
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
51
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -5,7 +5,7 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for suggesting a feature! Please fill out the form below so we can understand your idea.
|
Thanks for suggesting an improvement. Please describe the problem first so maintainers can evaluate the request.
|
||||||
|
|
||||||
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues?q=label%3Aenhancement) to avoid duplicates.
|
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues?q=label%3Aenhancement) to avoid duplicates.
|
||||||
|
|
||||||
|
|
@ -14,43 +14,29 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Pre-submission Checklist
|
label: Pre-submission Checklist
|
||||||
options:
|
options:
|
||||||
- label: I have searched existing issues and confirmed this feature has not been requested
|
- label: I have searched existing issues and confirmed this has not already been requested
|
||||||
required: true
|
required: true
|
||||||
- label: This is a feature request, not a bug report or question
|
- label: This is a feature request, not a bug report or support question
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: feature-type
|
|
||||||
attributes:
|
|
||||||
label: Feature Area
|
|
||||||
options:
|
|
||||||
- User Interface (UI)
|
|
||||||
- User Experience (UX)
|
|
||||||
- API / Backend
|
|
||||||
- Integrations / Plugins
|
|
||||||
- Security / Privacy
|
|
||||||
- Performance
|
|
||||||
- Other
|
|
||||||
validations:
|
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: problem-statement
|
id: problem
|
||||||
attributes:
|
attributes:
|
||||||
label: Problem or Use Case
|
label: Problem or Use Case
|
||||||
description: What problem does this feature solve? Why do you need it?
|
description: What problem does this solve? Describe the user need, not just the proposed UI or API.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
I often need to... but currently there's no way to...
|
I often need to ...
|
||||||
|
Today, this is difficult because ...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: proposed-solution
|
id: solution
|
||||||
attributes:
|
attributes:
|
||||||
label: Proposed Solution
|
label: Proposed Solution
|
||||||
description: Describe what you'd like to happen
|
description: Describe the behavior you would like Memos to support.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
It would be great if Memos could...
|
Memos should ...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
|
@ -58,21 +44,14 @@ body:
|
||||||
id: alternatives
|
id: alternatives
|
||||||
attributes:
|
attributes:
|
||||||
label: Alternatives Considered
|
label: Alternatives Considered
|
||||||
description: Have you considered any workarounds or alternative approaches?
|
description: Existing workarounds, related tools, or simpler alternatives you considered.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
I've tried... but it doesn't work well because...
|
I tried ...
|
||||||
|
It does not work well because ...
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additional-context
|
id: additional-context
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional Context
|
label: Additional Context
|
||||||
description: Mockups, screenshots, examples from other apps, or any other context
|
description: Mockups, screenshots, examples from other apps, API sketches, or any other context.
|
||||||
placeholder: Drag and drop images here...
|
placeholder: Drag and drop files here or add links/examples.
|
||||||
|
|
||||||
- type: checkboxes
|
|
||||||
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