chore: adding more required fields to issue creation template in github (#23261)

* chore: adding more required fields and cleaning up language in the issue creation template in github
This commit is contained in:
Ben M
2022-08-11 12:13:18 -04:00
committed by GitHub
parent 6d3b60acce
commit 0f6f59b379
2 changed files with 56 additions and 7 deletions

View File

@@ -9,7 +9,7 @@ body:
id: current-behavior
attributes:
label: Current behavior
description: A description including screenshots, stack traces, DEBUG logs, etc. [Troubleshooting tips](https://on.cypress.io/troubleshooting).
description: Please provide a description including screenshots, stack traces, etc. [Troubleshooting tips](https://on.cypress.io/troubleshooting).
placeholder: Currently...
validations:
required: true
@@ -23,7 +23,7 @@ body:
id: reproduction
attributes:
label: Test code to reproduce
description: Provide a failing test or repo we can run. You can fork [this repo](https://github.com/cypress-io/cypress-test-tiny), set up a failing test, then link to your fork. If you have never done this before, watch [this video](https://youtu.be/NnriKHmj5T8) for example.
description: Please provide a failing test or repo we can run. You can fork [this repo](https://github.com/cypress-io/cypress-test-tiny), set up a failing test, then link to your fork. If you have never done this before, watch [this video](https://youtu.be/NnriKHmj5T8) for example.
placeholder: Here is my failing test code and the app code to run the tests on...
validations:
required: true
@@ -31,10 +31,35 @@ body:
id: version
attributes:
label: Cypress Version
description: Run `cypress version` to see your current version. If possible, please update Cypress to the latest version first.
placeholder: ex. 7.6.0
description: What version of Cypress are you running? Run `cypress version` to see your current version. If possible, please update Cypress to the latest version first.
placeholder: ex. 10.3.1
validations:
required: true
- type: input
id: node-version
attributes:
label: Node version
description: What version of node.js are you using to run Cypress?
placeholder: ex. v16.16.0
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: What operating system is Cypress running on when you are encountering your problem? The more specific the better. ie macOS 12.4 or Windows 10.0.19044.1889
placeholder: ex. macOS 12.4
validations:
required: true
- type: textarea
id: debug-logs
attributes:
label: Debug Logs
description: Please run Cypress in [debug mode](https://docs.cypress.io/guides/references/troubleshooting#Print-DEBUG-logs) and print the entire set of logs here. This will often make it easier for Cypress developers to help in debugging your problem.
placeholder: Debug logging output
render: shell
validations:
required: false
- type: textarea
id: other
attributes:

View File

@@ -12,7 +12,7 @@ body:
id: current-behavior
attributes:
label: Current behavior
description: A description including screenshots, stack traces, DEBUG logs, etc. [Troubleshooting tips](https://on.cypress.io/troubleshooting).
description: Please provide a description including screenshots, stack traces, DEBUG logs, etc. [Troubleshooting tips](https://on.cypress.io/troubleshooting)
placeholder: When I try to download Cypress...
validations:
required: true
@@ -22,12 +22,21 @@ body:
label: Debug logs
description: Include DEBUG logs setting [`DEBUG=cypress:*`](https://on.cypress.io/troubleshooting#Print-DEBUG-logs/). Include npm/yarn logs if applicable.
placeholder: Debug logs
render: Text
- type: input
id: version
attributes:
label: Cypress Version
description: The version you're trying to install
placeholder: ex. 7.6.0
description: What version of Cypress are you trying to install?
placeholder: ex. 10.3.1
validations:
required: true
- type: input
id: node-version
attributes:
label: Node version
description: What version of node.js are you using to run Cypress?
placeholder: ex. v16.16.0
validations:
required: true
- type: dropdown
@@ -42,6 +51,13 @@ body:
- other
validations:
required: true
- type: input
id: package-manager-version
attributes:
label: Package Manager Version
description: What is the version of your chosen package manager?
validations:
required: true
- type: dropdown
id: operating-system
attributes:
@@ -53,6 +69,14 @@ body:
- other
validations:
required: true
- type: input
id: os-version
attributes:
label: Operating System Version
description: What is the version of the operating system you are running Cypress on?
placeholder: ex 12.4
validations:
required: true
- type: textarea
id: other
attributes: