chore: update issue templates

This commit is contained in:
Jiralite 2026-02-11 19:28:05 +00:00
parent aa4e5b0385
commit 17404f0e41
No known key found for this signature in database
3 changed files with 40 additions and 126 deletions

View File

@ -1,100 +1,57 @@
name: Bug report name: Bug report
description: Report a reproducible problem in fluxer description: Report a reproducible problem in Fluxer
title: 'bug: '
labels: ['bug'] labels: ['bug']
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for the report! Thanks for the report.
**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.
Before filing, please check for existing issues and include enough detail for someone else to reproduce.
- type: textarea - type: textarea
id: summary id: summary
attributes: attributes:
label: Summary label: Summary
description: What happened, in one or two sentences? description: What happened, and what did you expect instead?
placeholder: 'When I ..., the app ..., but I expected ...' placeholder: "When I ..., the app ..., but I expected ..."
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: repro id: repro
attributes: attributes:
label: Steps to reproduce label: Steps to reproduce
description: Provide clear, numbered steps. Include any relevant data/inputs. description: Provide clear, numbered steps.
placeholder: | placeholder: |
1. Go to ... 1. Go to ...
2. Click ... 2. Click ...
3. See error ... 3. See ...
validations: validations:
required: true 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 - type: textarea
id: environment id: environment
attributes: attributes:
label: Environment label: Environment (optional)
description: Include versions that matter (commit SHA/tag, OS, runtime, browser/device). description: Include versions that matter (commit/tag, OS, runtime, browser/device).
placeholder: | placeholder: |
- Commit/Tag: - Commit/Tag:
- OS: - OS:
- Runtime (node/go/python/etc): - Runtime:
- Browser (if applicable): - Browser (if applicable):
- Deployment (local/dev/prod):
validations: validations:
required: true required: false
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: Logs / screenshots label: Logs or screenshots (optional)
description: Paste logs (redact secrets) and/or attach screenshots/recordings. description: Paste logs (redact secrets) or attach screenshots/recordings.
placeholder: 'Paste stack traces, console output, network errors, etc.' placeholder: "Paste stack traces, console output, network errors, etc."
validations: validations:
required: false required: false
- type: checkboxes - type: checkboxes
id: checks id: checks
attributes: attributes:
label: Pre-flight checks label: Checks
options: options:
- label: I searched for existing issues and didn't find a duplicate. - label: I searched for existing issues and didn't find a duplicate.
required: true 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

View File

@ -1,45 +1,42 @@
name: Documentation name: Documentation
description: Report a docs issue or suggest an improvement description: Report a docs issue or suggest an improvement
title: 'docs: '
labels: ['docs'] labels: ['docs']
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | 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 - type: textarea
id: issue id: issue
attributes: attributes:
label: What's wrong or missing? label: What needs fixing?
description: Describe the docs gap, error, ambiguity, or outdated info. description: Describe the gap, error, or outdated content.
placeholder: 'The README says ..., but actually ...' placeholder: "The README says ..., but actually ..."
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: location id: location
attributes: attributes:
label: Where is it? label: Where is it? (optional)
description: Link the file/section if possible. description: Link the file/section if possible.
placeholder: "File: ...\nSection/heading: ...\nLink: ..." placeholder: "File: ...\nSection/heading: ...\nLink: ..."
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: suggestion id: suggestion
attributes: attributes:
label: Suggested improvement (optional) label: Suggested wording (optional)
description: If you already know how it should read, propose wording. description: If you already know how it should read, propose text.
placeholder: 'Proposed text: ...' placeholder: "Proposed text: ..."
validations: validations:
required: false required: false
- type: checkboxes - type: checkboxes
id: checks id: checks
attributes: attributes:
label: Pre-flight checks label: Checks
options: options:
- label: I searched for existing issues and didn't find a duplicate. - label: I searched for existing issues and didn't find a duplicate.
required: true required: true

View File

@ -1,82 +1,42 @@
name: Feature request name: Feature request
description: Suggest an improvement or new capability description: Suggest an improvement or new capability
title: 'feat: '
labels: ['enhancement'] labels: ['enhancement']
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | 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), For larger changes, please align with maintainers before investing time.
it's best to align with maintainers early; an issue like this is a great place to do that. Security issues should go to https://fluxer.app/security.
**Security note:** Please do not report security issues here. Use https://fluxer.app/security instead.
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
label: Problem / motivation label: Problem
description: What problem are you trying to solve? Who is it for? description: What problem are you trying to solve, and for whom?
placeholder: "Right now, users can't ..., which causes ..." placeholder: "Right now, users can't ..., which causes ..."
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: proposal id: proposal
attributes: attributes:
label: Proposed solution label: Proposed solution
description: What would you like to see happen? Include UX/API shape if relevant. description: What would you like to see happen?
placeholder: 'Add ..., so that ...' placeholder: "Add ..., so that ..."
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternatives id: notes
attributes: attributes:
label: Alternatives considered label: Notes (optional)
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
description: Constraints, rough plan, or links to relevant code. description: Constraints, rough plan, or links to relevant code.
placeholder: "Notes: ...\nPotential files/areas: ..." placeholder: "Notes: ...\nPotential files/areas: ..."
validations: validations:
required: false required: false
- type: checkboxes - type: checkboxes
id: contribution id: checks
attributes: attributes:
label: Contribution label: Checks
options: options:
- label: I'm willing to open a PR for this (after maintainer alignment). - label: I searched for existing issues and didn't find a duplicate.
required: false required: true
- label: I can help test/verify a PR for this.
required: false