chore: add github issue templates
This commit is contained in:
45
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal file
45
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal 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
|
||||
Reference in New Issue
Block a user