template improvements

webdriverio · Oct 21, 2021 · 52fe29f · 52fe29f
1 parent 20c2fa1
commit 52fe29f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 19 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -6,21 +6,19 @@ 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:
+        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
+      label: WebdriverIO Version
       description: What version of WebdriverIO are you running?
       placeholder: latest
     validations:
       required: true
   - type: input
     id: node-version
     attributes:
-      label: Version
+      label: Node.js Version
       description: What version of Node.js are you using?
       placeholder: latest
     validations:
@@ -30,7 +28,7 @@ body:
     attributes:
       label: Mode
       description: |
-        [Standalone mode](https://webdriver.io/docs/setuptypes#standalone-mode) or [WDIO Testrunner](https://webdriver.io/docs/setuptypes#the-wdio-testrunner)
+        [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
@@ -40,7 +38,7 @@ body:
     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.
+      description: If you think the bug is related to the capabilities you are using, please share them with us here.
       placeholder: |
         {
           browserName: 'chrome',
@@ -88,17 +86,16 @@ body:
         ```sh
         $ node reproducibleExample.js
         ````
-      render: shell
+      render: markdown
     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.
+        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

diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -6,14 +6,12 @@ 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.
+        Please let us know where we are not doing well with out documentation.
   - 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
+      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

diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -6,14 +6,12 @@ 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.
+        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 [...]
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...].
       render: markdown
     validations:
       required: true