chore(github): improve issue templates with structured triage fields

Add area dropdowns, reproduction requirements, regression info, and
compatibility sections to reduce back-and-forth on bug reports and
feature requests.
This commit is contained in:
boojack 2026-06-08 22:21:33 +08:00
parent ecbe2ab797
commit 6870e863de
2 changed files with 145 additions and 19 deletions

View file

@ -1,13 +1,18 @@
name: Bug Report name: Bug Report
description: Something isn't working as expected description: Report reproducible behavior that is broken in the current version
type: Bug type: Bug
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for reporting a bug. Please provide enough detail for maintainers to reproduce the issue. Thanks for reporting a bug. Please help maintainers reproduce it on current code.
**Before submitting**, please search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates. Before submitting:
- Search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates.
- Upgrade and retest with the [latest release](https://github.com/usememos/memos/releases/latest), current `main`, or the [demo site](https://demo.usememos.com/).
- Use [Discussions](https://github.com/usememos/memos/discussions) for questions, setup help, or configuration troubleshooting.
Maintainers normally fix bugs in current code and future releases, not older released versions.
- type: checkboxes - type: checkboxes
id: pre-check id: pre-check
@ -16,40 +21,100 @@ body:
options: options:
- label: I have searched existing issues and confirmed this has not already been reported - label: I have searched existing issues and confirmed this has not already been reported
required: true required: true
- label: I have reproduced this bug on the latest Memos release, current `main`, or the demo site, or this report is specifically about upgrading to the latest release
required: true
- label: This is a bug report, not a question or configuration request - label: This is a bug report, not a question or configuration request
required: true required: true
- type: dropdown
id: area
attributes:
label: Affected Area
description: Choose the main area where the bug appears.
multiple: true
options:
- Web UI
- API
- Authentication / SSO
- Database / migration
- Resources / attachments
- Search / filters
- Markdown / editor
- Deployment / startup
- Other
validations:
required: true
- type: dropdown
id: reproduced-on
attributes:
label: Reproduced On
description: Where did you confirm the issue still happens?
options:
- Latest release
- Current main branch
- Demo site
- Upgrade to latest release
- I cannot test the latest version
validations:
required: true
- type: input - type: input
id: version id: version
attributes: attributes:
label: Memos Version label: Memos Version Tested
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. description: Report the exact version where you reproduced the bug. 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.x, ghcr.io/usememos/memos:v0.25.x, main@abcdef, or demo site" placeholder: "v0.29.x, ghcr.io/usememos/memos:v0.29.x, main@abcdef, or demo site"
validations: validations:
required: true required: true
- type: input
id: previous-version
attributes:
label: Previous Version
description: If this happened after an upgrade, enter the version you upgraded from. Leave blank if not applicable.
placeholder: "v0.28.x, unknown, or not applicable"
- type: textarea - type: textarea
id: environment id: environment
attributes: attributes:
label: Environment Details label: Environment Details
description: Include anything relevant to where Memos is running. description: Include the deployment, database, client, and network details that apply.
placeholder: | placeholder: |
- Deployment: Docker / binary / source / demo site - Deployment: Docker / binary / source / demo site
- Database: SQLite / PostgreSQL / MySQL - Database: SQLite / PostgreSQL / MySQL
- Browser: Chrome 120 on macOS 15 - Browser: Firefox 126 on macOS 15
- Server OS: Ubuntu 24.04 - Server OS: Ubuntu 24.04
- Reverse proxy: nginx / Caddy / Traefik / none - Reverse proxy: nginx / Caddy / Traefik / none
- Related settings: SSO / SMTP / storage / webhooks / none
validations:
required: true
- type: dropdown
id: frequency
attributes:
label: Reproduction Frequency
description: How reliably can you reproduce this?
options:
- Always
- Often
- Sometimes
- Once
- Unknown
validations:
required: true
- type: textarea - type: textarea
id: reproduction-steps id: reproduction-steps
attributes: attributes:
label: Steps to Reproduce label: Steps to Reproduce
description: Minimal steps to reliably reproduce the issue description: Provide minimal, numbered steps that start from a clean page/session when possible.
placeholder: | placeholder: |
1. Go to ... 1. Open ...
2. Click ... 2. Click ...
3. Enter ... 3. Enter ...
4. See ... 4. Wait for ...
5. See ...
validations: validations:
required: true required: true
@ -57,7 +122,7 @@ body:
id: current-behavior id: current-behavior
attributes: attributes:
label: Current Behavior label: Current Behavior
description: What happened? Include exact error messages if available. description: What happened? Include exact error messages, status codes, or visible UI state if available.
placeholder: The application ... placeholder: The application ...
validations: validations:
required: true required: true
@ -71,6 +136,15 @@ body:
validations: validations:
required: true required: true
- type: textarea
id: regression
attributes:
label: Regression Information
description: If this worked before, describe when it last worked and what changed before it broke.
placeholder: |
This last worked in ...
It started after ...
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
@ -84,5 +158,5 @@ body:
id: additional-context id: additional-context
attributes: attributes:
label: Additional Context label: Additional Context
description: Attach screenshots, screen recordings, sample data, or links to related issues. description: Attach screenshots, screen recordings, sample data, exports, or links to related issues.
placeholder: Drag and drop files here or add any extra context. placeholder: Drag and drop files here or add any extra context.

View file

@ -1,13 +1,16 @@
name: Feature Request name: Feature Request
description: Suggest a new feature or improvement description: Propose a product improvement with a clear use case
type: Feature type: Feature
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for suggesting an improvement. Please describe the problem first so maintainers can evaluate the request. Thanks for suggesting an improvement. Please describe the problem and workflow 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:
- Search [existing feature requests](https://github.com/usememos/memos/issues?q=label%3Aenhancement) to avoid duplicates.
- Use [Discussions](https://github.com/usememos/memos/discussions) for broad ideas, setup help, or questions.
- Keep one feature request focused on one user problem.
- type: checkboxes - type: checkboxes
id: pre-check id: pre-check
@ -19,6 +22,28 @@ body:
- label: This is a feature request, not a bug report or support question - label: This is a feature request, not a bug report or support question
required: true required: true
- type: dropdown
id: area
attributes:
label: Area
description: Choose the main area this request affects.
multiple: true
options:
- Web UI
- Mobile / responsive experience
- API
- Authentication / SSO
- Administration
- Memo editor
- Search / filters
- Tags / organization
- Resources / attachments
- Import / export
- Deployment / operations
- Other
validations:
required: true
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
@ -30,11 +55,22 @@ body:
validations: validations:
required: true required: true
- type: textarea
id: users
attributes:
label: Who Would Use This?
description: Describe the user, role, team, or workflow that would benefit.
placeholder: |
This helps ...
They currently ...
validations:
required: true
- type: textarea - type: textarea
id: solution id: solution
attributes: attributes:
label: Proposed Solution label: Proposed Solution
description: Describe the behavior you would like Memos to support. description: Describe the behavior you would like Memos to support. Include UI, API, or configuration details if relevant.
placeholder: | placeholder: |
Memos should ... Memos should ...
validations: validations:
@ -49,9 +85,25 @@ body:
I tried ... I tried ...
It does not work well because ... It does not work well because ...
- type: textarea
id: compatibility
attributes:
label: Compatibility and Migration
description: Note any expected impact on existing users, APIs, storage, permissions, or deployments.
placeholder: |
This should not affect existing memos because ...
Existing API clients may need ...
- type: textarea
id: examples
attributes:
label: Examples
description: Link to screenshots, mockups, API sketches, related apps, or existing issues that show the desired behavior.
placeholder: Drag and drop files here or add links/examples.
- 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, API sketches, or any other context. description: Add any extra context that does not fit above.
placeholder: Drag and drop files here or add links/examples. placeholder: Any other details.