chore(github): add docs and maintenance issue templates (#2467)
This commit is contained in:
3
.github/ISSUE_TEMPLATE/bug.yml
vendored
3
.github/ISSUE_TEMPLATE/bug.yml
vendored
@@ -1,6 +1,7 @@
|
|||||||
name: 🐛 Bug Report
|
name: 🐛 Bug Report
|
||||||
description: Report a problem
|
description: Report a problem
|
||||||
labels: ['bug', 'awaiting triage']
|
labels: ['awaiting triage']
|
||||||
|
type: bug
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
|
|||||||
63
.github/ISSUE_TEMPLATE/documentation.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/documentation.yml
vendored
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
name: 📚 Documentation
|
||||||
|
description: Report a docs problem or suggest a docs improvement
|
||||||
|
title: "[Docs]: "
|
||||||
|
labels: ["documentation", "awaiting triage"]
|
||||||
|
type: task
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for helping improve the docs!
|
||||||
|
|
||||||
|
Use this template for documentation issues (typos, unclear steps, missing info, outdated screenshots).
|
||||||
|
For app bugs or feature ideas, please use the other templates.
|
||||||
|
- type: input
|
||||||
|
id: doc-location
|
||||||
|
attributes:
|
||||||
|
label: Page / Location
|
||||||
|
description: Link to the docs page or the file/path (e.g. https://docs.seerr.dev/... or README.md)
|
||||||
|
placeholder: "https://docs.seerr.dev/..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: doc-area
|
||||||
|
attributes:
|
||||||
|
label: Docs Area
|
||||||
|
options:
|
||||||
|
- docs site
|
||||||
|
- migration guide
|
||||||
|
- README / repo docs
|
||||||
|
- API / integrations
|
||||||
|
- other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: What’s wrong / missing?
|
||||||
|
description: Describe the issue in the docs.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: suggested-fix
|
||||||
|
attributes:
|
||||||
|
label: Suggested change
|
||||||
|
description: If you know what should be changed, describe it (or paste proposed wording).
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: search-existing
|
||||||
|
attributes:
|
||||||
|
label: Search Existing Issues
|
||||||
|
description: Have you searched existing issues to see if this has already been reported?
|
||||||
|
options:
|
||||||
|
- label: Yes, I have searched existing issues.
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
id: terms
|
||||||
|
attributes:
|
||||||
|
label: Code of Conduct
|
||||||
|
description: By submitting this issue, you agree to follow our Code of Conduct.
|
||||||
|
options:
|
||||||
|
- label: I agree to follow Seerr's [Code of Conduct](https://github.com/seerr-team/seerr/blob/develop/CODE_OF_CONDUCT.md).
|
||||||
|
required: true
|
||||||
3
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
3
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
@@ -1,6 +1,7 @@
|
|||||||
name: ✨ Feature Request
|
name: ✨ Feature Request
|
||||||
description: Suggest an idea
|
description: Suggest an idea
|
||||||
labels: ['enhancement', 'awaiting triage']
|
labels: ['awaiting triage']
|
||||||
|
type: feature
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
|
|||||||
65
.github/ISSUE_TEMPLATE/maintenance.yml
vendored
Normal file
65
.github/ISSUE_TEMPLATE/maintenance.yml
vendored
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
name: 🧰 Maintenance / Chore
|
||||||
|
description: CI, GitHub Actions, build, dependencies, refactors (non-feature work)
|
||||||
|
title: "[Chore]: "
|
||||||
|
labels: ["maintenance", "awaiting triage"]
|
||||||
|
type: task
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Maintainers / contributors: use this for internal tasks (CI, workflows, tooling, refactors).
|
||||||
|
If you're reporting a user-facing bug or requesting a feature, use the other templates.
|
||||||
|
- type: dropdown
|
||||||
|
id: area
|
||||||
|
attributes:
|
||||||
|
label: Area
|
||||||
|
options:
|
||||||
|
- CI / GitHub Actions
|
||||||
|
- build / packaging
|
||||||
|
- dependencies
|
||||||
|
- release process
|
||||||
|
- refactor / tech debt
|
||||||
|
- tooling / scripts
|
||||||
|
- other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: What needs doing and why?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: acceptance
|
||||||
|
attributes:
|
||||||
|
label: Acceptance criteria
|
||||||
|
description: What does "done" look like?
|
||||||
|
placeholder: |
|
||||||
|
- [ ] ...
|
||||||
|
- [ ] ...
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: related
|
||||||
|
attributes:
|
||||||
|
label: Related links
|
||||||
|
description: PRs, failing workflow runs, logs, or relevant issues.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: checkboxes
|
||||||
|
id: search-existing
|
||||||
|
attributes:
|
||||||
|
label: Search Existing Issues
|
||||||
|
description: Have you searched existing issues to see if this has already been reported?
|
||||||
|
options:
|
||||||
|
- label: Yes, I have searched existing issues.
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
id: terms
|
||||||
|
attributes:
|
||||||
|
label: Code of Conduct
|
||||||
|
description: By submitting this issue, you agree to follow our Code of Conduct.
|
||||||
|
options:
|
||||||
|
- label: I agree to follow Seerr's [Code of Conduct](https://github.com/seerr-team/seerr/blob/develop/CODE_OF_CONDUCT.md).
|
||||||
|
required: true
|
||||||
Reference in New Issue
Block a user