Skip to content

Commit

Permalink
Add bug and feature forms and discussion link to new issue page (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
esarver authored Mar 28, 2024
1 parent 934dadc commit f047406
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/00-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: Bug Report
description: Create an issue to let us know about a problem.
title: "[Bug]: "
labels:
- bug
- triage
body:
- type: checkboxes
attributes:
label: Pre-check
description: |
Please search through existing [issues](https://github.com/tektronix/tsp-toolkit/issues/)
and [discussions](https://github.com/tektronix/tsp-toolkit/discussions) before entering a new issue.
Feel free to 👍 any open issues that match the problem you encountered!
options:
- label: I have searched the existing issues and discussions to make sure my problem has not already been addressed.
required: true
- label: I have looked at the "Known Issues" Section of the marketplace page of all TSP Toolkit extensions.
required: true
- type: textarea
attributes:
label: Search Terms
description: |
What terms did you use to search for existing issues? These terms will help others
to find this issue later on.
placeholder: |
e.g. "debugger", "crash", "lost connection"
- type: dropdown
attributes:
label: TSP Toolkit Version
description: The version of `tektronix.tsp-toolkit` that you have installed.
multiple: false
options:
- "0.15.0"
- type: dropdown
attributes:
label: TSP Toolkit Develop Version
description: The version of `tektronix.tsp-toolkit-develop` that you have installed
multiple: false
options:
- "None"
- "0.15.0"
default: 0
- type: textarea
attributes:
label: "Steps to Reproduce"
description: List the steps you took to exhibit the issue.
placeholder: |
Example:
1. Open Command Pallette and enter "TSP: Open Terminal"
2. Select "New Connection"
3. Type in IP address for 2450
4. After connection, enter `print("some string that breaks the terminal")`
- type: textarea
attributes:
label: Expected Behavior
description: Let us know what you expect to happen.
placeholder: |
Example:
The terminal should receive `some string that breaks the terminal` back from
from the instrument. Followed by a new prompt.
- type: textarea
attributes:
label: Actual Behavior
description: Let us know what actually happened
placeholder: |
Example:
The terminal immediately disappeared with no messages.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug Report
description: Create an issue to let us know about a problem.
title: "[Feature]: "
labels:
- bug
- triage
body:
- type: checkboxes
attributes:
label: Pre-check
description: |
Please search through existing [issues](https://github.com/tektronix/tsp-toolkit/issues/)
and [discussions](https://github.com/tektronix/tsp-toolkit/discussions) before entering a new feature request.
Feel free to 👍 any open issues that match the problem you encountered!
options:
- label: I have searched the existing issues and discussions to make sure my problem has not already been addressed.
required: true
- label: I have looked at the "Known Issues" Section of the marketplace page of all TSP Toolkit extensions.
required: true
- type: textarea
attributes:
label: Feature Idea
description: Let us know in as much detail as you can the feature you would like.
placeholder: |
Example:
As a user, I would like to be able to see my instruments list in a side panel
as they are discovered so I can find the instrument I'm looking for quickly.
This would idealy include the model number, serial number, and connection
information for each instrument.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
blank_issues_enabled: false
contact_links:
- name: Community Support
url: https://github.com/tektronix/tsp-toolkit/discussions
about: Please ask and answer questions here.

0 comments on commit f047406

Please sign in to comment.