mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-15 14:11:50 +03:00
224 lines
7.5 KiB
Markdown
224 lines
7.5 KiB
Markdown
# Contributing
|
||
|
||
- [How to Contribute](#how-to-contribute)
|
||
* [Getting Code](#getting-code)
|
||
* [Code reviews](#code-reviews)
|
||
* [Code Style](#code-style)
|
||
* [API guidelines](#api-guidelines)
|
||
* [Commit Messages](#commit-messages)
|
||
* [Writing Documentation](#writing-documentation)
|
||
* [Adding New Dependencies](#adding-new-dependencies)
|
||
* [Running & Writing Tests](#running--writing-tests)
|
||
* [Public API Coverage](#public-api-coverage)
|
||
- [Contributor License Agreement](#contributor-license-agreement)
|
||
* [Code of Conduct](#code-of-conduct)
|
||
|
||
## How to Contribute
|
||
|
||
### Getting Code
|
||
|
||
1. Clone this repository
|
||
|
||
```bash
|
||
git clone https://github.com/microsoft/playwright
|
||
cd playwright
|
||
```
|
||
|
||
2. Install dependencies
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
3. Build Playwright
|
||
|
||
```bash
|
||
npm run build
|
||
```
|
||
|
||
4. Run all Playwright tests locally. For more information about tests, read [Running & Writing Tests](#running--writing-tests).
|
||
|
||
```bash
|
||
npm test
|
||
```
|
||
|
||
### Code reviews
|
||
|
||
All submissions, including submissions by project members, require review. We
|
||
use GitHub pull requests for this purpose. Consult
|
||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
||
information on using pull requests.
|
||
|
||
### Code Style
|
||
|
||
- Coding style is fully defined in [.eslintrc](https://github.com/microsoft/playwright/blob/main/.eslintrc.js)
|
||
- Comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory.
|
||
|
||
To run code linter, use:
|
||
|
||
```bash
|
||
npm run eslint
|
||
```
|
||
|
||
### API guidelines
|
||
|
||
When authoring new API methods, consider the following:
|
||
|
||
- Expose as little information as needed. When in doubt, don’t expose new information.
|
||
- Methods are used in favor of getters/setters.
|
||
- The only exception is namespaces, e.g. `page.keyboard` and `page.coverage`
|
||
- All string literals must be lowercase. This includes event names and option values.
|
||
- Avoid adding "sugar" API (API that is trivially implementable in user-space) unless they're **very** common.
|
||
|
||
### Commit Messages
|
||
|
||
Commit messages should follow the Semantic Commit Messages format:
|
||
|
||
```
|
||
label(namespace): title
|
||
|
||
description
|
||
|
||
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.
|
||
- `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
|
||
2. *namespace* is put in parenthesis after label and is optional. Must be lowercase.
|
||
3. *title* is a brief summary of changes.
|
||
4. *description* is **optional**, new-line separated from title and is in present tense.
|
||
5. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues.
|
||
|
||
Example:
|
||
|
||
```
|
||
fix(firefox): make sure session cookies work
|
||
|
||
This patch fixes session cookies in the firefox browser.
|
||
|
||
Fixes #123, fixes #234
|
||
```
|
||
|
||
### Writing Documentation
|
||
|
||
All API classes, methods, and events should have a description in [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src). There's a [documentation linter](https://github.com/microsoft/playwright/tree/main/utils/doclint) which makes sure documentation is aligned with the codebase.
|
||
|
||
To run the documentation linter, use:
|
||
|
||
```bash
|
||
npm run doc
|
||
```
|
||
|
||
### Adding New Dependencies
|
||
|
||
For all dependencies (both installation and development):
|
||
- **Do not add** a dependency if the desired functionality is easily implementable.
|
||
- If adding a dependency, it should be well-maintained and trustworthy.
|
||
|
||
A barrier for introducing new installation dependencies is especially high:
|
||
- **Do not add** installation dependency unless it's critical to project success.
|
||
|
||
### Running & Writing Tests
|
||
|
||
- Every feature should be accompanied by a test.
|
||
- Every public api event/method should be accompanied by a test.
|
||
- Tests should be *hermetic*. Tests should not depend on external services.
|
||
- Tests should work on all three platforms: Mac, Linux and Win. This is especially important for screenshot tests.
|
||
|
||
Playwright tests are located in [`tests`](https://github.com/microsoft/playwright/blob/main/tests) and use `@playwright/test` test runner.
|
||
These are integration tests, making sure public API methods and events work as expected.
|
||
|
||
- To run all tests:
|
||
|
||
```bash
|
||
npm run test
|
||
```
|
||
|
||
- To run all tests in Chromium
|
||
```bash
|
||
npm run ctest # also `ftest` for firefox and `wtest` for WebKit
|
||
```
|
||
|
||
- To run a specific test, substitute `it` with `it.only`, or use the `--grep 'My test'` CLI parameter:
|
||
|
||
```js
|
||
...
|
||
// Using "it.only" to run a specific test
|
||
it.only('should work', async ({server, page}) => {
|
||
const response = await page.goto(server.EMPTY_PAGE);
|
||
expect(response.ok).toBe(true);
|
||
});
|
||
// or
|
||
playwright test --config=xxx --grep 'should work'
|
||
```
|
||
|
||
- To disable a specific test, substitute `it` with `it.skip`:
|
||
|
||
```js
|
||
...
|
||
// Using "it.skip" to skip a specific test
|
||
it.skip('should work', async ({server, page}) => {
|
||
const response = await page.goto(server.EMPTY_PAGE);
|
||
expect(response.ok).toBe(true);
|
||
});
|
||
```
|
||
|
||
- To run tests in non-headless (headed) mode:
|
||
|
||
```bash
|
||
HEADFUL=1 npm run ctest
|
||
```
|
||
|
||
- To run tests with custom browser executable, specify `CRPATH`, `WKPATH` or `FFPATH` env variable that points to browser executable:
|
||
|
||
```bash
|
||
CRPATH=<path-to-executable> npm run ctest
|
||
```
|
||
|
||
- To run tests in slow-mode:
|
||
|
||
```bash
|
||
HEADFUL=1 SLOW_MO=500 npm run wtest
|
||
```
|
||
|
||
- When should a test be marked with `skip` or `fail`?
|
||
|
||
- **`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).
|
||
|
||
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.
|
||
|
||
## Contributor License Agreement
|
||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
||
|
||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||
|
||
### Code of Conduct
|
||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|