Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an issue template to report issues properly #118

Merged
merged 2 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Bug Report
description: Create a report to help us fix broken features
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to open this issue to help improve PyVista!
- type: textarea
id: what-happened
attributes:
label: Describe the bug, what's wrong, and what you expected.
description: |
Provide a clear and concise description of what the bug is.
Provide a clear and concise description of what you expected to happen.
placeholder: Tell us what you see!
value: "I found a bug!"
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the bug.
description: |
Please provide a list of steps to reproduce the bug.
Please include a code snippet to reproduce the bug in the text box below.
placeholder: Provide some code for us to reproduce the bug!
value: "```python\nInsert code here\n```"
validations:
required: true
- type: textarea
id: system-information
attributes:
label: System Information
placeholder: The log will automatically be formatted! No need to type backticks.
description: |
Please run the following code wherever you are experiencing the bug, and paste the output below.
This report helps us track down bugs and will be critical to addressing your bug.
```python
# Get system info
import pmmsh as pm
print(pm.Report())
```
render: shell
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, please add screenshots to the text box below
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Questions and Discussions
url: https://github.com/pyvista/pmmsh/discussions
about: For general questions and discussions
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Feature Request
description: Request that a feature be added to PyVista
labels: ["feature-request"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to open this issue to help improve PyVista!
- type: textarea
id: feature-details
attributes:
label: Describe the feature you would like to be added.
description: |
Provide a clear and concise description of what you would like added.
placeholder: Tell us what you see!
value: "I have an idea for a new feature!"
validations:
required: true
- type: textarea
id: VTK-Links
attributes:
label: Links to VTK Documentation, Examples, or Class Definitions.
description: If you are requesting that a feature from VTK be wrapped or exposed, please include the relevant links below.
- type: textarea
id: pseudocode-and-screenshots
attributes:
label: Pseudocode or Screenshots
description: Feel free to include pseudocode or screenshots of the requested outcome.
placeholder: Provide some code for us to reproduce the bug!
value: "```python\nInsert code here\n```\nOr drag your screenshot here!"
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Maintenance Request
description: Request general maintenance to code, CI, deployment, or otherwise
labels: ["maintenance"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to open this issue to help improve PyVista!
- type: textarea
id: maintenance-request
attributes:
label: Describe what maintenance you would like added.
description: |
Provide a clear and concise description of the maintenance problem.
placeholder: Tell us what you see!
value: "I have a maintenance suggestion!"
validations:
required: true
- type: textarea
id: code-links
attributes:
label: Links to source code.
description: If you are requesting maintenance for a specific line of source code, please include the permanent link for that line.
- type: textarea
id: pseudocode-and-screenshots
attributes:
label: Pseudocode or Screenshots
description: Feel free to include pseudocode or screenshots of the requested outcome.
placeholder: Provide some code for us to reproduce the bug!
value: "```python\nInsert code here\n```\nOr drag your screenshot here!"