docs: relax issue template requirements
This commit is contained in:
parent
3b02d1c493
commit
f78a3f8663
71
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
71
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -6,7 +6,7 @@ body:
|
|||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to report a bug. Please include enough detail for us to reproduce it.
|
||||
Thanks for taking the time to report a bug. Screenshots, recordings, or files are often enough if exact steps are hard to describe.
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
|
|
@ -18,39 +18,6 @@ body:
|
|||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Provide the smallest reliable reproduction you can.
|
||||
placeholder: |
|
||||
1. Open OpenPencil on …
|
||||
2. Import …
|
||||
3. Select …
|
||||
4. See …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: affected-area
|
||||
attributes:
|
||||
label: Affected area
|
||||
description: Pick all areas that seem related.
|
||||
multiple: true
|
||||
options:
|
||||
- App UI
|
||||
- Canvas rendering
|
||||
- .fig import/export
|
||||
- SVG/PDF/raster export
|
||||
- CLI
|
||||
- MCP / automation
|
||||
- Tauri desktop
|
||||
- Collaboration
|
||||
- Documentation
|
||||
- Not sure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
|
|
@ -62,9 +29,39 @@ body:
|
|||
- Linux (Tauri)
|
||||
- CLI
|
||||
- MCP server
|
||||
- Not sure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Optional, but very helpful when you know the exact steps.
|
||||
placeholder: |
|
||||
1. Open OpenPencil on …
|
||||
2. Import …
|
||||
3. Select …
|
||||
4. See …
|
||||
|
||||
- type: dropdown
|
||||
id: affected-area
|
||||
attributes:
|
||||
label: Affected area
|
||||
description: Optional triage hint.
|
||||
multiple: true
|
||||
options:
|
||||
- App UI
|
||||
- Canvas rendering
|
||||
- .fig import/export
|
||||
- SVG/PDF/raster export
|
||||
- CLI
|
||||
- MCP / automation
|
||||
- Tauri desktop
|
||||
- Collaboration
|
||||
- Documentation
|
||||
- Not sure
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
|
|
@ -81,7 +78,7 @@ body:
|
|||
- type: textarea
|
||||
id: files
|
||||
attributes:
|
||||
label: Files or links
|
||||
label: Files, screenshots, or links
|
||||
description: Attach relevant .fig/.pen/SVG files, screenshots, screen recordings, or link to a Figma file if possible.
|
||||
placeholder: Drag files here or paste links.
|
||||
|
||||
|
|
@ -98,6 +95,4 @@ body:
|
|||
label: Before submitting
|
||||
options:
|
||||
- label: I searched existing issues and did not find a duplicate.
|
||||
required: true
|
||||
- label: I included a minimal reproduction or explained why I cannot provide one.
|
||||
required: true
|
||||
required: false
|
||||
|
|
|
|||
29
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
29
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -6,7 +6,7 @@ body:
|
|||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for suggesting an improvement. Strong feature requests describe the workflow, not just the solution.
|
||||
Thanks for suggesting an improvement. It is okay if you do not know the implementation details — describe the workflow or problem as clearly as you can.
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
|
|
@ -23,23 +23,18 @@ body:
|
|||
id: proposal
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: Describe the behavior you would like OpenPencil to support.
|
||||
description: What behavior would you like OpenPencil to support?
|
||||
placeholder: |
|
||||
Add support for …
|
||||
It should work by …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: Optional, but helpful. How do you work around this today? Are there simpler alternatives?
|
||||
|
||||
- type: dropdown
|
||||
id: affected-area
|
||||
attributes:
|
||||
label: Affected area
|
||||
description: Optional triage hint.
|
||||
multiple: true
|
||||
options:
|
||||
- App UI
|
||||
|
|
@ -52,20 +47,18 @@ body:
|
|||
- Collaboration
|
||||
- Documentation
|
||||
- Not sure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: figma-reference
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Figma or design-tool reference
|
||||
description: If this exists in Figma or another tool, describe how it works there. Screenshots and links help.
|
||||
label: Alternatives or workarounds
|
||||
description: Optional. How do you work around this today? Are there simpler alternatives?
|
||||
|
||||
- type: textarea
|
||||
id: examples
|
||||
id: references
|
||||
attributes:
|
||||
label: Examples or mockups
|
||||
description: Attach screenshots, sketches, files, or links that make the request concrete.
|
||||
label: References, examples, or mockups
|
||||
description: Optional. Add Figma/design-tool references, screenshots, sketches, files, or links that make the request concrete.
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
|
|
@ -73,6 +66,4 @@ body:
|
|||
label: Before submitting
|
||||
options:
|
||||
- label: I searched existing issues and did not find a duplicate.
|
||||
required: true
|
||||
- label: I described the user problem, not only an implementation detail.
|
||||
required: true
|
||||
required: false
|
||||
|
|
|
|||
45
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
45
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
name: Question or support
|
||||
description: Ask how to use OpenPencil or clarify expected behavior
|
||||
title: "question: "
|
||||
labels: [question]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Use this for usage questions, setup problems, or cases where you are not sure whether something is a bug or feature request.
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: What are you trying to do? What did you try already?
|
||||
placeholder: |
|
||||
I am trying to …
|
||||
I expected …
|
||||
I tried …
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Area
|
||||
description: Optional triage hint.
|
||||
multiple: true
|
||||
options:
|
||||
- App UI
|
||||
- Canvas rendering
|
||||
- .fig import/export
|
||||
- SVG/PDF/raster export
|
||||
- CLI
|
||||
- MCP / automation
|
||||
- Tauri desktop
|
||||
- Collaboration
|
||||
- Documentation
|
||||
- Not sure
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Context
|
||||
description: Optional. Add screenshots, logs, links, or files that help explain the question.
|
||||
Loading…
Reference in a new issue