You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
label: Have you read the Contributing Guidelines on issues?
9
+
options:
10
+
- label: I have read the [Contributing Guidelines on issues](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md#reporting-new-issues).
11
+
required: true
12
+
13
+
- type: markdown
14
+
attributes:
15
+
value: |
16
+
Thanks for taking the time to fill out this bug report! First, let's get some information about the environment you are using:
17
+
18
+
- type: input
19
+
id: vscode-wdio-version
20
+
attributes:
21
+
label: WebdriverIO Extension Version
22
+
description: What version of WebdriverIO Extension are you running?
23
+
placeholder: latest
24
+
validations:
25
+
required: true
26
+
27
+
- type: input
28
+
id: wdio-version
29
+
attributes:
30
+
label: WebdriverIO Version
31
+
description: What version of WebdriverIO are you running?
32
+
placeholder: latest
33
+
validations:
34
+
required: true
35
+
36
+
- type: input
37
+
id: node-version
38
+
attributes:
39
+
label: Node.js Version
40
+
description: What version of Node.js are you using?
41
+
placeholder: latest
42
+
validations:
43
+
required: true
44
+
45
+
- type: textarea
46
+
id: capabilities
47
+
attributes:
48
+
label: Which capabilities are you using?
49
+
description: If you think the bug is related to the capabilities you are using, please share them with us here.
50
+
placeholder: |
51
+
{
52
+
browserName: 'chrome',
53
+
browserVersion: 'latest',
54
+
platformName: 'Windows 10'
55
+
}
56
+
render: typescript
57
+
validations:
58
+
required: false
59
+
60
+
- type: textarea
61
+
id: what-happened
62
+
attributes:
63
+
label: What happened?
64
+
description: |
65
+
Describe clearly and concisely the bug including instructions showing how to reproduce it.
66
+
placeholder: |
67
+
Please add as many details as possible to avoid assumptions from our side. How do you
68
+
trigger this bug? What did you expect to happen? Please walk us through it step by step.
69
+
validations:
70
+
required: true
71
+
72
+
- type: textarea
73
+
id: what-is-expected
74
+
attributes:
75
+
label: What is your expected behavior?
76
+
description: |
77
+
What did you expect to happen instead?
78
+
validations:
79
+
required: false
80
+
81
+
- type: textarea
82
+
id: reproducible-example
83
+
attributes:
84
+
label: How to reproduce the bug.
85
+
description: |
86
+
It is essential for us to be able to reproduce the bug on our own machines.
87
+
Please either create a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
88
+
in a [new repository](https://github.com/new), a [gist](https://gist.github.com/)
89
+
or copy and paste all necessary files in here.
90
+
91
+
> **What happens if you skip this step?** Someone will read your bug report, and maybe will be able to help you, but it’s unlikely that it will get much attention from the team. Eventually, the issue will likely get closed in favor of issues that have reproducible demos.
92
+
93
+
Please remember that:
94
+
95
+
- Issues without reproducible demos have a very low priority.
96
+
- The person fixing the bug would have to do that anyway. Please be respectful of their time.
97
+
- You might figure out the issues yourself as you work on extracting it.
98
+
99
+
Thanks for helping us help you!
100
+
placeholder: |
101
+
To reproduce the bug, create a file with the following code:
102
+
```js
103
+
...
104
+
```
105
+
Then run:
106
+
```sh
107
+
$ node reproducibleExample.js
108
+
````
109
+
validations:
110
+
required: true
111
+
112
+
- type: textarea
113
+
id: logs
114
+
attributes:
115
+
label: Relevant log output
116
+
description: |
117
+
Please copy and paste any relevant log output. Either paste the terminal
118
+
output of this extension with set the `webdriverio.logLevel` as `debug`.Additionally set [`outputDir`](https://webdriver.io/docs/options#outputdir) in your WDIO config and copy the files content in here.
119
+
render: typescript
120
+
validations:
121
+
required: true
122
+
123
+
- type: checkboxes
124
+
id: terms
125
+
attributes:
126
+
label: Code of Conduct
127
+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/vscode-webdriverio/blob/main/CODE_OF_CONDUCT.md)
128
+
options:
129
+
- label: I agree to follow this project's Code of Conduct
130
+
required: true
131
+
132
+
- type: checkboxes
133
+
attributes:
134
+
label: Is there an existing issue for this?
135
+
description: Please search to see if an issue already exists for the bug you encountered.
description: Suggest improvements or report missing/unclear documentation.
3
+
title: '[📖 Docs]: <title>'
4
+
labels: [Docs 📖, Needs Triaging ⏳]
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
Please let us know where we are not doing well with out documentation.
10
+
11
+
- type: checkboxes
12
+
id: awareness
13
+
attributes:
14
+
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.
16
+
options:
17
+
- label: I know I can edit the docs but prefer to file this issue
18
+
required: true
19
+
20
+
- type: dropdown
21
+
id: type
22
+
attributes:
23
+
label: Describe the improvement
24
+
multiple: true
25
+
options:
26
+
- Unclear documentation
27
+
- A typo
28
+
- Missing documentation
29
+
- Other
30
+
validations:
31
+
required: true
32
+
33
+
- type: textarea
34
+
id: report
35
+
attributes:
36
+
label: Description of the improvement / report
37
+
description: A clear and concise description.
38
+
validations:
39
+
required: true
40
+
41
+
- type: checkboxes
42
+
id: terms
43
+
attributes:
44
+
label: Code of Conduct
45
+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/vscode-webdriverio/blob/main/CODE_OF_CONDUCT.md)
46
+
options:
47
+
- label: I agree to follow this project's Code of Conduct
Thanks for taking the time and for sharing your great idea with us. Like many WebdriverIO extension is an open source project and lives from these great ideas.
10
+
11
+
- type: textarea
12
+
id: problem
13
+
attributes:
14
+
label: Is your feature request related to a problem?
15
+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...].
16
+
validations:
17
+
required: true
18
+
19
+
- type: textarea
20
+
id: solution
21
+
attributes:
22
+
label: Describe the solution you'd like.
23
+
description: A clear and concise description of what you want to happen.
24
+
validations:
25
+
required: true
26
+
27
+
- type: textarea
28
+
id: alternatives
29
+
attributes:
30
+
label: Describe alternatives you've considered.
31
+
description: A clear and concise description of any alternative solutions or features you've considered.
32
+
validations:
33
+
required: false
34
+
35
+
- type: textarea
36
+
id: context
37
+
attributes:
38
+
label: Additional context
39
+
description: Add any other context or screenshots about the feature request here.
40
+
validations:
41
+
required: false
42
+
43
+
- type: checkboxes
44
+
id: terms
45
+
attributes:
46
+
label: Code of Conduct
47
+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdriverio/vscode-webdriverio/blob/main/CODE_OF_CONDUCT.md)
48
+
options:
49
+
- label: I agree to follow this project's Code of Conduct
[//]: #'Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.'
4
+
5
+
## Types of changes
6
+
7
+
[//]: #'What types of changes does your code introduce to WebdriverIO?'
8
+
[//]: #'_Put an `x` in the boxes that apply_'
9
+
10
+
-[ ] Polish (an improvement for an existing feature)
11
+
-[ ] Bugfix (non-breaking change which fixes an issue)
12
+
-[ ] New feature (non-breaking change which adds functionality)
13
+
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14
+
-[ ] Documentation update (improvements to the project's docs)
15
+
-[ ] Specification changes (updates to WebDriver command specifications)
16
+
-[ ] Internal updates (everything related to internal scripts, governance documentation and CI files)
17
+
18
+
## Checklist
19
+
20
+
[//]: #"_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._"
21
+
22
+
-[ ] I have read the [CONTRIBUTING](https://github.com/webdriverio/vscode-webdriverio/blob/main/CONTRIBUTION.md) doc
23
+
-[ ] I have added tests that prove my fix is effective or that my feature works
24
+
-[ ] I have added the necessary documentation (if appropriate)
25
+
-[ ] I have added proper type definitions for new commands (if appropriate)
26
+
27
+
## Further comments
28
+
29
+
[//]: #'If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...'
Copy file name to clipboardExpand all lines: CONTRIBUTION.md
+78-1Lines changed: 78 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,83 @@ How to develop and build this extension:
41
41
$ pnpm coverage
42
42
```
43
43
44
-
# Package structure
44
+
## Reporting New Issues
45
45
46
+
When [opening a new issue](https://github.com/webdriverio/vscode-webdriverio/issues/new/choose), always make sure to fill out the issue template. **This step is very important!** Not doing so may result in your issue not managed in a timely fashion. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.
47
+
48
+
- **One issue, one bug:** Please report a single bug per issue.
49
+
- **Provide reproduction steps:** List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.
50
+
51
+
### Providing a reproducible example
52
+
53
+
A reproducible example is a simple, self-contained script or program that demonstrates the issue or bug you're experiencing. The goal is to allow others to recreate the problem easily and efficiently.
54
+
55
+
Steps to Create a Reproducible Example:
56
+
57
+
1. Isolate the Problem:
58
+
59
+
- Narrow down your code to the smallest amount that still reproduces the issue.
60
+
- Remove any non-essential code or dependencies that are not related to the problem.
61
+
62
+
2. Ensure that others can run your example and reproduce the issue:
63
+
64
+
- It should not require any non-standard setup unless absolutely necessary, e.g. remove any need for special software or services like CI vendors.
65
+
- Document steps necessary to execute the reproducible example
66
+
67
+
3. Share project
68
+
69
+
- Create a new public GitHub repository and push your reproducible example to it.
70
+
- Share the link to the repository in the issue.
71
+
- Document what behavior you observe and what behavior you would expect
72
+
73
+
**Note:** if you can't provide a reproducible example we unfortunately are forced to close the issue.
74
+
75
+
## Proposing a Change
76
+
77
+
We are happy for every idea you have that improves the usability of the framework. If you have an idea about a new feature please raise a [feature request](https://github.com/webdriverio/vscode-webdriverio/issues/new?template=--feature-request.md) first to get feedback by the maintainer team on it. This lets us reach an agreement on your proposal before you put significant effort into it.
78
+
79
+
If you’re only fixing a bug, it’s fine to submit a pull request right away, but we still recommend to file an issue detailing what you’re fixing. This is helpful incase we don’t accept that specific fix but want to keep track of the issue.
80
+
81
+
### Work With The Code
82
+
83
+
If you make any changes to the code, you want to test it quickly to see if they do what you expect. There are a couple of ways to do that in WebdriverIO. For one, you can link single sub-packages into your own project to see if the changes you've made have the effect you expected.
84
+
85
+
Another way to test changes in WebdriverIO Extension is by using its [sample directory](https://github.com/webdriverio/vscode-webdriverio/tree/main/samples) or by running its [E2E test suite](https://github.com/webdriverio/vscode-webdriverio/tree/main/e2e). The sample directory is a set of sample that use WebdriverIO Extension in various of ways. Here, you need to open as workspace using VSCode. With the E2E test suite you can run various flavors of WebdriverIO Extension within a predefined execution scenario.
86
+
87
+
### Make a Pull Request
88
+
89
+
Once you have a fix implemented or finished a feature implementation you can make a pull request. Your changes needs to be pushed on your WebdriverIO Extension fork. In the GitHub UI you should see a button popping up that allows you to raise a PR to the main repository.
90
+
91
+
We already provide a template for you to fill out. There are not many rules to follow here. Just try to explain your change with as much detail as possible. Make sure that you have written enough unit tests for your changes otherwise the code coverage check will let the build fail.
92
+
93
+
Like in many Open Source projects we ask you to sign a **CLA** which is a Contributor License Agreement that ensures that all contributions to the project are licensed under the project's respective open source license, which is MIT. It regulates the legal implications of you providing us (as the OpenJS Foundation) code changes.
94
+
95
+
The WebdriverIO maintainer will review your pull request as soon as possible. They will then either approve and merge your changes, request modifications or close with an explanation.
96
+
97
+
### Package structure
98
+
99
+
This Extension consists of several packages. Eventually, these packages will be bundled with `esbuild` and published as an Extension of VSCode.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<h1align="center">WebdriverIO extension for Visual Studio Code.</h1>
2
2
3
3
<palign="center">
4
-
<atitle="WebdriverIO extension for Visual Studio Code"href="https://github.com/webdriverio/vscode-webdriverio"><imgsrc="./assets/vscode-webdriverio.png"alt="WebdriverIO extension for Visual Studio Code"width="50%" /></a>
4
+
<atitle="WebdriverIO extension for Visual Studio Code"href="https://github.com/webdriverio/vscode-webdriverio"><imgsrc="./assets/vscode-webdriverio.png"alt="WebdriverIO extension for Visual Studio Code"width="80%" /></a>
0 commit comments