mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
Overhaul the bug report form and restructure issue intake for 2.0: - Bug report: split actual vs expected behavior, add Affected area and Specific tool fields for triage, replace the self-defeating required "latest version" checkbox with a Version field that accepts a tag, release, or commit (always answerable from any install), modernize Docker guidance to the Compose stack, add Host OS, and fix the previously required image-tag field that source users could not fill. - Move feature requests to GitHub Discussions: delete the feature_request issue form, rename the orphaned discussion form to ideas.yml so it binds to the built-in Ideas category, and point config.yml there. - Add Translation and Documentation issue forms routed to existing labels. - Remove the roadmap-update discussion form (roadmap is private). - Reconcile CONTRIBUTING.md, SUPPORT.md, and the published docs contributing guide with the new routing.
62 lines
1.6 KiB
YAML
62 lines
1.6 KiB
YAML
name: Documentation Issue
|
|
description: Report wrong, missing, or unclear documentation
|
|
title: "[Docs] "
|
|
labels: ["documentation", "area: docs"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for helping improve the docs. For small fixes, a direct PR to apps/docs/ is welcome too.
|
|
|
|
- type: checkboxes
|
|
id: checklist
|
|
attributes:
|
|
label: Before submitting
|
|
options:
|
|
- label: I searched existing issues and didn't find a duplicate
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: kind
|
|
attributes:
|
|
label: Issue type
|
|
options:
|
|
- Incorrect or outdated
|
|
- Missing / not documented
|
|
- Unclear or confusing
|
|
- Broken link or example
|
|
- Typo or formatting
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: page
|
|
attributes:
|
|
label: Page
|
|
description: Link to the docs page. If it's missing, link the closest page to where it belongs.
|
|
placeholder: "e.g. https://docs.snapotter.com/guide/configuration"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: What's wrong?
|
|
description: Describe what's incorrect, missing, or confusing.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: suggestion
|
|
attributes:
|
|
label: Suggested fix
|
|
description: If you have a correction or wording suggestion, share it here.
|
|
|
|
- type: dropdown
|
|
id: willing-to-fix
|
|
attributes:
|
|
label: Would you like to submit a PR?
|
|
options:
|
|
- "No, just reporting"
|
|
- "Yes, I'd like to submit a PR"
|