Skip to content

A Swiss Army knife for developers.

Updated bug and feature template

Etienne Baudouxfbcb2a9e84e8
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 565b1bb32..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Configuration (please complete the following information):**
- - OS & Version: [e.g. Windows 10 1903]
- - Theme: [e.g. Dark]
- - DevToys app version [e.g 1.0.0.0]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..156e91641
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,48 @@
+name: Bug Report
+description: Create a bug report to help improve DevToys
+labels: [bug]
+body:
+ - type: textarea
+ attributes:
+ label: Description
+ description: A clear and concise description of what the bug is.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Steps To Reproduce
+ description: Steps to reproduce the behavior.
+ placeholder: |
+ 1. Go to '....'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See the error
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Expected behavior
+ description: A clear and concise description of what you expected to happen.
+ validations:
+ required: true
+ - type: input
+ id: devtoys-version
+ attributes:
+ label: DevToys Version
+ description: Which version of DevToys are you using? The version number can be found by going to DevToys' Settings > About
+ placeholder: "e.g. Version: 1.0.0.0 | X64; OS Version: 10.0.22000.282"
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Relevant Assets/Logs
+ description: |
+ A list of assets (logs, screenshots, etc) relevant to this bug.
+
+ Tip: You can attach image(s) or log file(s) by clicking this area to highlight it and then dragging files in.
+ placeholder: |
+ To upload the log, access it from Settings -> About -> Open log location; Or
+ - Copy the `logs.txt` file from `%localappdata%\Packages\64360VelerSoftware.DevToys_j80j2txgjg9dj\LocalCache`
+ - Drag and drop them into this text area.
+ validations:
+ required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 62db22048..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- Please keep the text below -->
-Vote on this issue by adding a 👍 reaction.
-If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)
-<!-- Please keep the text above -->
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..a257dc3b0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,55 @@
+name: Feature Request
+description: This project thrives from differentiation from competing apps. Suggest an idea for DevToys
+labels: [feature request]
+body:
+ - type: textarea
+ attributes:
+ label: What's the Problem?
+ description: If your feature request is related to a problem, describe it clearly.
+ - type: textarea
+ attributes:
+ label: Solution/Idea
+ description: Describe your solution/idea.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Alternatives
+ description: Describe alternatives you've considered
+ validations:
+ required: true
+ - type: markdown
+ attributes:
+ value: |
+ ---
+
+ Please include a list of what the feature should and shouldn't do by filling in the table below.
+
+ 'Must' implies that the feature should not ship without this capability.
+ 'Should' is something we should push hard for, but is not absolutely required to ship.
+ 'Could' is a nice-to-have; a good stretch goal that isn't painful if we don't achieve it.
+ 'Won't' is a clear statement that the proposal/feature will intentionally not have that capability.
+
+ This list will evolve and grow as the proposal becomes more refined over time.
+ A good rule of thumb is to start your proposal with no more than 7 high-level requirements.
+ - type: textarea
+ attributes:
+ label: Priorities
+ description: describe all the elements of your idea and how important they are.
+ value: |
+ | Capability | Priority |
+ | :---------- | :------- |
+ | This proposal will allow developers to accomplish W | Must |
+ | This proposal will allow end users to accomplish X | Should |
+ | This proposal will allow developers to accomplish Y | Could |
+ | This proposal will allow end users to accomplish Z | Won't |
+ - type: input
+ id: devtoys-version
+ attributes:
+ label: DevToys Version
+ description: Which version of DevToys are you using? The version number can be found by going to DevToys' Settings > About
+ placeholder: "e.g. Version: 1.0.0.0 | X64; OS Version: 10.0.22000.282"
+ - type: textarea
+ attributes:
+ label: Comments
+ description: Additional information, comments or screenshots about the feature request.
\ No newline at end of file