From 587f5b1b6cb7e1f89c400f4619bdf9af4f7bf306 Mon Sep 17 00:00:00 2001 From: boojack Date: Fri, 17 Apr 2026 23:54:17 +0800 Subject: [PATCH] chore(github): simplify issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 89 ++++++++++------------ .github/ISSUE_TEMPLATE/feature_request.yml | 51 ++++--------- 2 files changed, 54 insertions(+), 86 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 75f0b585..ad34e274 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: 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. @@ -14,61 +14,31 @@ body: attributes: label: Pre-submission Checklist 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 - - 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) + - label: This is a bug report, not a question or configuration request required: true - type: input id: version attributes: label: Memos Version - description: Find this in **Settings > System > About** or via the `--version` flag - placeholder: "v0.25.2" + 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.x, ghcr.io/usememos/memos:v0.25.x, main@abcdef, or demo site" validations: 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 - id: bug-description + id: environment attributes: - label: Bug Description - description: A clear and concise description of what the bug is - placeholder: When I try to..., the application... - validations: - required: true + label: Environment Details + description: Include anything relevant to where Memos is running. + placeholder: | + - Deployment: Docker / binary / source / demo site + - Database: SQLite / PostgreSQL / MySQL + - Browser: Chrome 120 on macOS 15 + - Server OS: Ubuntu 24.04 + - Reverse proxy: nginx / Caddy / Traefik / none - type: textarea id: reproduction-steps @@ -76,9 +46,19 @@ body: label: Steps to Reproduce description: Minimal steps to reliably reproduce the issue placeholder: | - 1. Go to '...' - 2. Click on '...' - 3. See error + 1. Go to ... + 2. Click ... + 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: required: true @@ -91,9 +71,18 @@ body: validations: 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 id: additional-context attributes: - label: Screenshots, Logs & Additional Context - description: Attach screenshots, browser console errors, or server logs if available - placeholder: Drag and drop images here, or paste error logs... + label: Additional Context + description: Attach screenshots, screen recordings, sample data, or links to related issues. + placeholder: Drag and drop files here or add any extra context. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index ec1ff0cf..c30728c9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: 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. @@ -14,43 +14,29 @@ body: attributes: label: Pre-submission Checklist 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 - - 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 - - type: textarea - id: problem-statement + id: problem attributes: 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: | - I often need to... but currently there's no way to... + I often need to ... + Today, this is difficult because ... validations: required: true - type: textarea - id: proposed-solution + id: solution attributes: label: Proposed Solution - description: Describe what you'd like to happen + description: Describe the behavior you would like Memos to support. placeholder: | - It would be great if Memos could... + Memos should ... validations: required: true @@ -58,21 +44,14 @@ body: id: alternatives attributes: label: Alternatives Considered - description: Have you considered any workarounds or alternative approaches? + description: Existing workarounds, related tools, or simpler alternatives you considered. placeholder: | - I've tried... but it doesn't work well because... + I tried ... + It does not work well because ... - type: textarea id: additional-context attributes: label: Additional Context - description: Mockups, screenshots, examples from other apps, or any other context - placeholder: Drag and drop images here... - - - 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 + description: Mockups, screenshots, examples from other apps, API sketches, or any other context. + placeholder: Drag and drop files here or add links/examples.