Skip to content

Commit acf551f

Browse files
committed
chore: add issue templates
1 parent 5ea1153 commit acf551f

2 files changed

Lines changed: 110 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: Report a bug to help us improve trame-vtklocal
3+
labels: ["status: needs-triage", "type: bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Description
13+
description: A clear and concise description of what the bug is.
14+
placeholder: I encountered an issue when...
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: origin
19+
attributes:
20+
label: Where does the issue originate?
21+
description: Does this feel like a bug in this wrapper/example, or in the core upstream project?
22+
options:
23+
- "This project (trame-vtklocal)"
24+
- "Upstream Project (trame)"
25+
- "Upstream Project (vtk.wasm JS bindings)"
26+
- "Upstream Project (VTK itself)"
27+
- "Unsure / Need help triaging"
28+
validations:
29+
required: true
30+
- type: input
31+
id: version-info
32+
attributes:
33+
label: Version Information
34+
description: Please provide the version of this project AND the upstream project version.
35+
placeholder: trame-vtklocal - v1.2.3, VTK - v9.6.0
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: reproduction
40+
attributes:
41+
label: Steps to Reproduce
42+
description: How can we make this happen again? If you're not sure, please provide as much detail as you can about what you were doing when the bug happened.
43+
placeholder: |
44+
1. Run this code snippet...
45+
2. Click this button...
46+
3. Observe this incorrect behavior instead of the expected behavior
47+
4. See error
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: Relevant Log Output
54+
description: Please copy and paste any relevant terminal or browser console output.
55+
render: shell
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "Feature Request"
2+
description: "Suggest an idea, a new example, or an improvement"
3+
labels: ["status: needs-triage", "type: enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Got a great idea? We'd love to hear it. Please check if a similar request already exists before opening a new one.
9+
- type: textarea
10+
id: feature-description
11+
attributes:
12+
label: "What is the feature or improvement?"
13+
description: "A clear and concise description of what you want to happen."
14+
placeholder: "I would like the ability to..."
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: request-type
19+
attributes:
20+
label: "Category"
21+
description: "What part of the project does this affect?"
22+
options:
23+
- "New Example (Code snippets, demos, use-cases)"
24+
- "Core Logic (Source code changes)"
25+
- "Documentation / Tutorials"
26+
- "Upstream Integration (support new VTK features)"
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: use-case
31+
attributes:
32+
label: "The 'Why'"
33+
description: "What problem does this solve? What is the use case?"
34+
placeholder: "This would allow users to..."
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: proposed-example
39+
attributes:
40+
label: "Proposed Example / Implementation"
41+
description: "If this is a request for a new example, what should it demonstrate? If it's a code change, how should the API look?"
42+
placeholder: "I'm imagining a demo that shows off..."
43+
- type: checkboxes
44+
id: upstream-check
45+
attributes:
46+
label: "Upstream Considerations"
47+
options:
48+
- label: "This requires a change in the upstream project first"
49+
- label: "I am willing to contribute an example or PR for this"
50+
- type: textarea
51+
id: additional-context
52+
attributes:
53+
label: "Additional Context"
54+
description: "Any other context, screenshots, or links to upstream discussions."
55+
placeholder: "Add any other context or screenshots about the feature request here."

0 commit comments

Comments
 (0)