diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0434e95f..825c502c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,100 +1,57 @@ name: Bug report -description: Report a reproducible problem in fluxer -title: 'bug: ' +description: Report a reproducible problem in Fluxer labels: ['bug'] body: - type: markdown attributes: value: | - Thanks for the report! + Thanks for the report. - **Security note:** Please do not report security issues here. Use https://fluxer.app/security instead. - - Before filing, please check for existing issues and include enough detail for someone else to reproduce. + Please check for existing issues before filing. + Security issues should go to https://fluxer.app/security. - type: textarea id: summary attributes: label: Summary - description: What happened, in one or two sentences? - placeholder: 'When I ..., the app ..., but I expected ...' + description: What happened, and what did you expect instead? + placeholder: "When I ..., the app ..., but I expected ..." validations: required: true - - type: textarea id: repro attributes: label: Steps to reproduce - description: Provide clear, numbered steps. Include any relevant data/inputs. + description: Provide clear, numbered steps. placeholder: | 1. Go to ... 2. Click ... - 3. See error ... + 3. See ... validations: required: true - - - type: textarea - id: expected - attributes: - label: Expected behavior - placeholder: 'It should ...' - validations: - required: true - - - type: textarea - id: actual - attributes: - label: Actual behavior - placeholder: 'Instead, it ...' - validations: - required: true - - - type: dropdown - id: area - attributes: - label: Area - description: Where does this bug appear? - options: - - Backend / API - - Frontend / Web - - Mobile - - CLI / tooling - - CI / build - - Docs - - Not sure - validations: - required: true - - type: textarea id: environment attributes: - label: Environment - description: Include versions that matter (commit SHA/tag, OS, runtime, browser/device). + label: Environment (optional) + description: Include versions that matter (commit/tag, OS, runtime, browser/device). placeholder: | - Commit/Tag: - OS: - - Runtime (node/go/python/etc): + - Runtime: - Browser (if applicable): - - Deployment (local/dev/prod): validations: - required: true - + required: false - type: textarea id: logs attributes: - label: Logs / screenshots - description: Paste logs (redact secrets) and/or attach screenshots/recordings. - placeholder: 'Paste stack traces, console output, network errors, etc.' + label: Logs or screenshots (optional) + description: Paste logs (redact secrets) or attach screenshots/recordings. + placeholder: "Paste stack traces, console output, network errors, etc." validations: required: false - - type: checkboxes id: checks attributes: - label: Pre-flight checks + label: Checks options: - label: I searched for existing issues and didn't find a duplicate. required: true - - label: This is not a security vulnerability report (those go to https://fluxer.app/security). - required: true - - label: I included enough information to reproduce the issue. - required: true diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml index f0745468..93cd8f0d 100644 --- a/.github/ISSUE_TEMPLATE/docs.yml +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -1,45 +1,42 @@ name: Documentation description: Report a docs issue or suggest an improvement -title: 'docs: ' labels: ['docs'] body: - type: markdown attributes: value: | - Thanks! Clear docs save everyone time. + Thanks. - **Security note:** Please do not report security issues here. Use https://fluxer.app/security instead. + Please check for existing issues before filing. + Security issues should go to https://fluxer.app/security. - type: textarea id: issue attributes: - label: What's wrong or missing? - description: Describe the docs gap, error, ambiguity, or outdated info. - placeholder: 'The README says ..., but actually ...' + label: What needs fixing? + description: Describe the gap, error, or outdated content. + placeholder: "The README says ..., but actually ..." validations: required: true - - type: textarea id: location attributes: - label: Where is it? + label: Where is it? (optional) description: Link the file/section if possible. placeholder: "File: ...\nSection/heading: ...\nLink: ..." validations: required: false - - type: textarea id: suggestion attributes: - label: Suggested improvement (optional) - description: If you already know how it should read, propose wording. - placeholder: 'Proposed text: ...' + label: Suggested wording (optional) + description: If you already know how it should read, propose text. + placeholder: "Proposed text: ..." validations: required: false - - type: checkboxes id: checks attributes: - label: Pre-flight checks + label: Checks options: - label: I searched for existing issues and didn't find a duplicate. required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 5bbcd0bb..273a550b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,82 +1,42 @@ name: Feature request description: Suggest an improvement or new capability -title: 'feat: ' labels: ['enhancement'] body: - type: markdown attributes: value: | - Thanks for taking the time to propose an improvement. + Thanks for the suggestion. - If this is **larger work** (new feature, meaningful refactor, new dependency, new API surface, behavior change), - it's best to align with maintainers early; an issue like this is a great place to do that. - - **Security note:** Please do not report security issues here. Use https://fluxer.app/security instead. + For larger changes, please align with maintainers before investing time. + Security issues should go to https://fluxer.app/security. - type: textarea id: problem attributes: - label: Problem / motivation - description: What problem are you trying to solve? Who is it for? + label: Problem + description: What problem are you trying to solve, and for whom? placeholder: "Right now, users can't ..., which causes ..." validations: required: true - - type: textarea id: proposal attributes: label: Proposed solution - description: What would you like to see happen? Include UX/API shape if relevant. - placeholder: 'Add ..., so that ...' + description: What would you like to see happen? + placeholder: "Add ..., so that ..." validations: required: true - - type: textarea - id: alternatives + id: notes attributes: - label: Alternatives considered - description: Other approaches you considered, and why they're worse. - placeholder: "- Option A: ...\n- Option B: ..." - validations: - required: false - - - type: dropdown - id: impact - attributes: - label: Impact - description: Roughly how big is this change? - options: - - Small (localized, low risk) - - Medium (touches multiple areas) - - Large (new surface area / refactor / dependency) - - Not sure - validations: - required: true - - - type: checkboxes - id: compatibility - attributes: - label: Compatibility - options: - - label: This might be a breaking change (behavior/API). - required: false - - label: This introduces a new dependency. - required: false - - - type: textarea - id: scope - attributes: - label: Scope / implementation notes + label: Notes (optional) description: Constraints, rough plan, or links to relevant code. placeholder: "Notes: ...\nPotential files/areas: ..." validations: required: false - - type: checkboxes - id: contribution + id: checks attributes: - label: Contribution + label: Checks options: - - label: I'm willing to open a PR for this (after maintainer alignment). - required: false - - label: I can help test/verify a PR for this. - required: false + - label: I searched for existing issues and didn't find a duplicate. + required: true