Debian Codegraph @

.github/ISSUE_TEMPLATE/bug-report.yml

raw
1 name: Bug Report
2 description: Create a report to help us fix broken features
3 labels: ["bug"]
4 body:
5 - type: markdown
6 attributes:
7 value: |
8 Thanks for taking the time to open this issue to help improve PyVista!
9 - type: textarea
10 id: what-happened
11 attributes:
12 label: Describe the bug, what's wrong, and what you expected.
13 description: |
14 Provide a clear and concise description of what the bug is.
15 Provide a clear and concise description of what you expected to happen.
16 placeholder: Tell us what you see!
17 value: "I found a bug!"
18 validations:
19 required: true
20 - type: textarea
21 id: reproduce
22 attributes:
23 label: Steps to reproduce the bug.
24 description: |
25 Please provide a list of steps to reproduce the bug.
26 Please include a code snippet to reproduce the bug in the text box below.
27 placeholder: Provide some code for us to reproduce the bug!
28 value: "```python\nInsert code here\n```"
29 validations:
30 required: true
31 - type: textarea
32 id: system-information
33 attributes:
34 label: System Information
35 placeholder: The log will automatically be formatted! No need to type backticks.
36 description: |
37 Please run the following wherever you are experiencing the bug, and paste the output below.
38 This report helps us track down bugs and will be critical to addressing your bug.
39
40 With python code (e.g. inside IPython or Jupyter Notebook):
41
42 ```python
43 # Get system info
44 import pyvista as pv
45 print(pv.Report())
46 ```
47
48 Or with a shell command (requires `pyvista>=0.47`):
49
50 ```shell
51 pyvista report
52 ```
53 render: shell
54 validations:
55 required: true
56 - type: textarea
57 id: dataset-information
58 attributes:
59 label: Dataset Information
60 description: |
61 If a custom dataset is needed to reproduce the bug, upload the dataset here or provide a download link.
62 In addition, use the `validate_mesh` filter on it and paste the output below.
63
64 For a dataset 'file.vtk', run python code:
65
66 ```python
67 import pyvista as pv
68 mesh = pv.read('file.vtk')
69 print(mesh.validate_mesh())
70 ```
71
72 Or with a shell command (requires `pyvista>=0.48`):
73
74 ```shell
75 pyvista validate file.vtk --report
76 ```
77 - type: textarea
78 id: screenshots
79 attributes:
80 label: Screenshots
81 description: If applicable, please add screenshots to the text box below