chore: add github issue templates

This commit is contained in:
Hampus Kraft 2026-01-05 14:25:03 +00:00
parent 2ea1c6ba2e
commit 7bc22f8ada
No known key found for this signature in database
GPG Key ID: 6090864C465A454D
4 changed files with 232 additions and 0 deletions

100
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,100 @@
name: Bug report
description: Report a reproducible problem in fluxer
title: 'bug: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
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.
- type: textarea
id: summary
attributes:
label: Summary
description: What happened, in one or two sentences?
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.
placeholder: |
1. Go to ...
2. Click ...
3. See error ...
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).
placeholder: |
- Commit/Tag:
- OS:
- Runtime (node/go/python/etc):
- Browser (if applicable):
- Deployment (local/dev/prod):
validations:
required: true
- 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.'
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Pre-flight 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

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability report
url: https://fluxer.app/security
about: Please report security issues privately using our security policy.

45
.github/ISSUE_TEMPLATE/docs.yml vendored Normal file
View File

@ -0,0 +1,45 @@
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.
**Security note:** Please do not report security issues here. Use https://fluxer.app/security instead.
- 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 ...'
validations:
required: true
- type: textarea
id: location
attributes:
label: Where is it?
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: ...'
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Pre-flight checks
options:
- label: I searched for existing issues and didn't find a duplicate.
required: true

View File

@ -0,0 +1,82 @@
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.
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.
- type: textarea
id: problem
attributes:
label: Problem / motivation
description: What problem are you trying to solve? Who is it for?
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 ...'
validations:
required: true
- type: textarea
id: alternatives
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
description: Constraints, rough plan, or links to relevant code.
placeholder: "Notes: ...\nPotential files/areas: ..."
validations:
required: false
- type: checkboxes
id: contribution
attributes:
label: Contribution
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