Skip to content

Commit 064fc03

Browse files
authored
docs: update about pre-requests (#52)
1 parent 1a2f849 commit 064fc03

6 files changed

Lines changed: 12 additions & 5 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ body:
77
attributes:
88
label: Have you read the Contributing Guidelines on issues?
99
options:
10-
- label: I have read the [Contributing Guidelines on issues](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md#reporting-new-issues).
10+
- label: I have read the [Contributing Guidelines on issues](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTING.md#reporting-new-issues).
1111
required: true
1212

1313
- type: markdown

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
id: awareness
1313
attributes:
1414
label: Pre-check
15-
description: I'm aware that I can [edit the docs](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md) and submit a pull request.
15+
description: I'm aware that I can [edit the docs](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTING.md) and submit a pull request.
1616
options:
1717
- label: I know I can edit the docs but prefer to file this issue
1818
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
[//]: # "_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._"
2020

21-
- [ ] I have read the [CONTRIBUTING](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md) doc
21+
- [ ] I have read the [CONTRIBUTING](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTING.md) doc
2222
- [ ] I have added tests that prove my fix is effective or that my feature works
2323
- [ ] I have added the necessary documentation (if appropriate)
2424
- [ ] I have added proper type definitions for new commands (if appropriate)
File renamed without changes.

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
## Requirements
2020

21-
- Visual Studio Code version >= 1.98.0
21+
- Visual Studio Code version >= 1.96.0
2222
- WebdriverIO version >= v9.0.0
2323
- Node.js version >= 18.0.0 (follows WebdriverIO)
2424

@@ -29,6 +29,13 @@ You can manage tests both from the Testing view.
2929
The WebdriverIO uses vscode's `TestController' APIs to provide a unified testing experience.<br>
3030
You can read the official guides about how to run the tests in the VSCode Documentation.
3131

32+
### First step
33+
34+
It is necessary to install WebdriverIO to your project. (See also [project docs](https://webdriver.io))
35+
36+
Please ensure that there is at least one configuration file of WebdriverIO that is named according to the pattern `*wdio*.conf*.{ts, js, mjs, cjs, cts, mts}`.
37+
This extension is enabled when a matching file exists in the workspace (workspace root folder and sub-folder are supported).
38+
3239
### Testing view
3340

3441
![Testing view](./assets/testing-view.png 'Testing view')

infra/release/src/changelog.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ if (!process.env.GITHUB_AUTH) {
2424
shell.exec('git checkout -- .')
2525
console.error(
2626
'Please export a "GITHUB_AUTH" access token to generate the changelog.\n' +
27-
'See also https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md#release-new-version'
27+
'See also https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTING.md#release-new-version'
2828
)
2929
process.exit(1)
3030
}

0 commit comments

Comments
 (0)