Skip to content

Commit

Permalink
update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
christian-bromann committed Oct 21, 2021
1 parent 05908b6 commit 20c2fa1
Show file tree
Hide file tree
Showing 6 changed files with 217 additions and 75 deletions.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/--bug-report.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/--documentation.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/--feature-request.md

This file was deleted.

119 changes: 119 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
name: 🐛 Bug Report
description: Create a report to help us improve.
title: "[🐛 Bug]: <title>"
labels: [Bug 🐛, Needs Triaging ⏳]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
First, let's get some information about the environment
you are using:
- type: input
id: wdio-version
attributes:
label: Version
description: What version of WebdriverIO are you running?
placeholder: latest
validations:
required: true
- type: input
id: node-version
attributes:
label: Version
description: What version of Node.js are you using?
placeholder: latest
validations:
required: true
- type: dropdown
id: mode
attributes:
label: Mode
description: |
[Standalone mode](https://webdriver.io/docs/setuptypes#standalone-mode) or [WDIO Testrunner](https://webdriver.io/docs/setuptypes#the-wdio-testrunner)
options:
- Standalone Mode
- WDIO Testrunner
validations:
required: true
- type: textarea
id: capabilities
attributes:
label: Which capabilities are you using?
description: If you the bug is related to the capabilities your are using, please share them with us here.
placeholder: |
{
browserName: 'chrome',
browserVersion: 'latest',
platformName: 'Windows 10'
}
render: shell
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: |
Describe clearly and concisely the bug including instructions showing how to reproduce it.
placeholder: |
Please add as many details as possible to avoid assumptions from our side. How do you
trigger this bug? What did you expect to happen? Please walk us through it step by step.
render: markdown
validations:
required: true
- type: textarea
id: what-is-expected
attributes:
label: What is your expected behavior?
description: |
What did you expect to happen instead?
render: markdown
validations:
required: false
- type: textarea
id: reproducible-example
attributes:
label: How to reproduce the bug.
description: |
Please understand that it is essential for us to be able to reproduce
the bug on our own machines. Please either create a [new repository](https://github.com/new),
a [gist](https://gist.github.com/) or copy and paste all necessary files in here.
placeholder: |
To reproduce the bug, create a file with the following code:
```js
...
```
Then run:
```sh
$ node reproducibleExample.js
````
render: shell
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. Either paste the terminal output
or set [`outputDir`](https://webdriver.io/docs/options#outputdir) in your WDIO
config and copy the files content in here.
render: shell
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/webdriverio/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 📖 Documentation
description: Suggest improvements or report missing/unclear documentation.
title: "[📖 Docs]: <title>"
labels: [Docs 📖, Needs Triaging ⏳]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time and for sharing your great idea with us.
Like many WebdriverIO is an open source project and lives from these
great ideas.
- type: checkboxes
id: awareness
attributes:
label: Pre-check
description: I'm aware that I can [edit the docs](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md) and submit a pull request
options:
- label: I know I can edit the docs but prefer to file this issue
required: true
- type: dropdown
id: type
attributes:
label: Describe the improvement
multiple: true
options:
- Unclear documentation
- A typo
- Missing documentation
- Other
validations:
required: true
- type: textarea
id: report
attributes:
label: Description of the improvement / report
description: A clear and concise description.
render: markdown
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/webdriverio/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 💡 Feature request
description: Suggest an idea for WebdriverIO.
title: "[💡 Feature]: <title>"
labels: [Idea 💡, Needs Triaging ⏳]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time and for sharing your great idea with us.
Like many WebdriverIO is an open source project and lives from these
great ideas.
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
render: markdown
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like.
description: A clear and concise description of what you want to happen.
render: markdown
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered.
description: A clear and concise description of any alternative solutions or features you've considered.
render: markdown
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
render: markdown
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/webdriverio/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

0 comments on commit 20c2fa1

Please sign in to comment.