diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c95fcf36..d8fa7782 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,162 +1,59 @@ name: Bug Report -description: Report reproducible behavior that is broken in the current version +description: Report something that is not working as expected type: Bug body: - type: markdown attributes: value: | - Thanks for reporting a bug. Please help maintainers reproduce it on current code. + Thanks for reporting a bug. - 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. + Before submitting, please search [existing issues](https://github.com/usememos/memos/issues) and, if possible, check the [latest release](https://github.com/usememos/memos/releases/latest). For questions and setup help, use [Discussions](https://github.com/usememos/memos/discussions). - type: checkboxes id: pre-check attributes: - label: Pre-submission Checklist + label: Check before submitting options: - - label: I have searched existing issues and confirmed this has not already been reported + - label: I searched existing issues and did not find a duplicate 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 - 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 - id: version - attributes: - label: Memos Version Tested - 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.29.x, ghcr.io/usememos/memos:v0.29.x, main@abcdef, or demo site" - validations: - 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 - id: environment + id: description attributes: - label: Environment Details - description: Include the deployment, database, client, and network details that apply. + label: Describe the bug + description: Tell us what happened and what you expected instead. placeholder: | - - Deployment: Docker / binary / source / demo site - - Database: SQLite / PostgreSQL / MySQL - - Browser: Firefox 126 on macOS 15 - - Server OS: Ubuntu 24.04 - - 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 + What happened: + What I expected: validations: required: true - type: textarea id: reproduction-steps attributes: - label: Steps to Reproduce - description: Provide minimal, numbered steps that start from a clean page/session when possible. + label: Steps to reproduce + description: Give us the shortest steps that reproduce the problem. placeholder: | - 1. Open ... + 1. Go to ... 2. Click ... - 3. Enter ... - 4. Wait for ... - 5. See ... + 3. See ... validations: required: true - - type: textarea - id: current-behavior + - type: input + id: version attributes: - label: Current Behavior - description: What happened? Include exact error messages, status codes, or visible UI state if available. - placeholder: The application ... + label: Memos version + description: Use the version from Settings > System, the image tag, or `memos --version`. + placeholder: "v0.29.x or main@abcdef" validations: required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected Behavior - description: What did you expect to happen instead? - placeholder: I expected... - validations: - 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 - 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: Additional Context - description: Attach screenshots, screen recordings, sample data, exports, or links to related issues. - placeholder: Drag and drop files here or add any extra context. + label: Additional context + description: Add relevant deployment details, logs, screenshots, or recordings. Remove secrets before submitting. + placeholder: | + Deployment / database / browser: + Logs or screenshots: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 2903a16f..565b90fe 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,109 +1,42 @@ name: Feature Request -description: Propose a product improvement with a clear use case +description: Suggest an improvement to Memos type: Feature body: - type: markdown attributes: value: | - Thanks for suggesting an improvement. Please describe the problem and workflow first so maintainers can evaluate the request. + Thanks for suggesting an improvement. Please keep the request focused on one problem. - 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. + Before submitting, search [existing issues](https://github.com/usememos/memos/issues) to avoid duplicates. For broad ideas and questions, use [Discussions](https://github.com/usememos/memos/discussions). - type: checkboxes id: pre-check attributes: - label: Pre-submission Checklist + label: Check before submitting options: - - label: I have searched existing issues and confirmed this has not already been requested + - label: I searched existing issues and did not find a duplicate required: true - - label: This is a feature request, not a bug report or support question - 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 id: problem attributes: - label: Problem or Use Case - description: What problem does this solve? Describe the user need, not just the proposed UI or API. - placeholder: | - I often need to ... - Today, this is difficult because ... - validations: - 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 ... + label: What problem would this solve? + description: Briefly describe what you are trying to do and why it is difficult today. + placeholder: I want to ... but currently ... validations: required: true - type: textarea id: solution attributes: - label: Proposed Solution - description: Describe the behavior you would like Memos to support. Include UI, API, or configuration details if relevant. - placeholder: | - Memos should ... + label: What would you like to happen? + description: Describe the behavior you would like Memos to support. + placeholder: It would be helpful if Memos could ... validations: required: true - - type: textarea - id: alternatives - attributes: - label: Alternatives Considered - description: Existing workarounds, related tools, or simpler alternatives you considered. - placeholder: | - I tried ... - 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 id: additional-context attributes: - label: Additional Context - description: Add any extra context that does not fit above. - placeholder: Any other details. + label: Additional context + description: Add workarounds, examples, screenshots, mockups, or related links if useful.