Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse source 
Signed-off-by: Max Schmitt <max@schmitt.mx>
This commit is contained in:
Max Schmitt 2024-07-15 16:14:58 +02:00 committed by GitHub
parent fbc4583a48
commit 2ffa956e68
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
CONTRIBUTING.md
View file

@ -46,6 +46,16 @@ npm ci
npm run build
```
4. Run tests
This will run a test on line `23` in `page-fill.spec.ts`:
```bash
npm run ctest -- page-fill:23
```
See [here](#running--writing-tests) for more information about running and writing tests.
### Code reviews
All submissions, including submissions by project members, require review. We
@ -89,7 +99,7 @@ footer
1. *label* is one of the following:
- `fix` - playwright bug fixes.
- `feat` - playwright features.
- `docs` - changes to docs, e.g. `docs(api.md): ..` to change documentation.
- `docs` - changes to docs, e.g. `docs(api): ..` to change documentation.
- `test` - changes to playwright tests infrastructure.
- `devops` - build-related work, e.g. CI related patches and general changes to the browser build infrastructure
- `chore` - everything that doesn't fall under previous categories
@ -115,7 +125,7 @@ All API classes, methods, and events should have a description in [`docs/src`](h
To run the documentation linter, use:
```bash
npm run doc
npm run doclint
```
To build the documentation site locally and test how your changes will look in practice:
@ -159,6 +169,8 @@ npm run ctest # also `ftest` for firefox and `wtest` for WebKit
npm run ctest -- page-fill:23 # runs line 23 of page-fill.spec.ts
```
To run tests in WebKit / Firefox, use `wtest` or `ftest`.
- To run the Playwright test runner tests
```bash
npm run ttest
@ -201,25 +213,13 @@ npm run ctest -- --headed
CRPATH=<path-to-executable> npm run ctest
```
- When should a test be marked with `skip` or `fail`?
- When should a test be marked with `skip` or `fixme`?
- **`skip(condition)`**: This test *should ***never*** work* for `condition`
where `condition` is usually a certain browser like `FFOX` (for Firefox),
`WEBKIT` (for WebKit), and `CHROMIUM` (for Chromium).
where `condition` is usually something like: `test.skip(browserName === 'chromium', 'This does not work because of ...')`.
For example, the [alt-click downloads test](https://github.com/microsoft/playwright/blob/471ccc72d3f0847caa36f629b394a028c7750d93/test/download.spec.js#L86) is marked
with `skip(FFOX)` since an alt-click in Firefox will not produce a download
even if a person was driving the browser.
- **`fail(condition)`**: This test *should ***eventually*** work* for `condition`
where `condition` is usually a certain browser like `FFOX` (for Firefox),
`WEBKIT` (for WebKit), and `CHROMIUM` (for Chromium).
For example, the [alt-click downloads test](https://github.com/microsoft/playwright/blob/471ccc72d3f0847caa36f629b394a028c7750d93/test/download.spec.js#L86) is marked
with `fail(CHROMIUM || WEBKIT)` since Playwright performing these actions
currently diverges from what a user would experience driving a Chromium or
WebKit.
- **`fixme(condition)`**: This test *should ***eventually*** work* for `condition`
where `condition` is usually something like: `test.fixme(browserName === 'chromium', 'We are waiting for version x')`.
## Contributor License Agreement