Skip to content

Commit

Permalink
Update playwright e2e utils readme (#44016)
Browse files Browse the repository at this point in the history
* Try outputting documentation for each file in a folder specified by the token

* Revert "Try outputting documentation for each file in a folder specified by the token"

This reverts commit 4ea68f5.

* Add contributing info

* Remove experimental wording
  • Loading branch information
talldan authored Sep 12, 2022
1 parent b46a98b commit d3cc24f
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions packages/e2e-test-utils-playwright/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# E2E Test Utils

Experimental End-To-End (E2E) Playwright test utils for WordPress.

**This package is still experimental and breaking changes could be introduced in future minor versions (`v0.x`). Use it at your own risks.**
End-To-End (E2E) Playwright test utils for WordPress.

_It works properly with the minimum version of Gutenberg `9.2.0` or the minimum version of WordPress `5.6.0`._

Expand All @@ -20,7 +18,7 @@ npm install @wordpress/e2e-test-utils-playwright --save-dev

### test

The extended Playwright's [test](https://playwright.dev/docs/api/class-test) module with the `admin`, `pageUtils` and the `requestUtils` fixtures.
The extended Playwright's [test](https://playwright.dev/docs/api/class-test) module with the `admin`, `editor`, `pageUtils` and the `requestUtils` fixtures.

### expect

Expand Down Expand Up @@ -80,4 +78,10 @@ const requestUtils = await RequestUtils.setup( {
} );
```

<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
## Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).

<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

0 comments on commit d3cc24f

Please sign in to comment.