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

docs: improve readability with additional subheaders(CONTRIBUTING.md)

Browse source
This commit is contained in:
pengoosedev 2024-10-18 03:31:35 +09:00 committed by Pengoose
parent 4b187107ee
commit 7124bbd1e2
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -8,6 +8,8 @@ If you are passioned about a bug/feature, but cannot find an issue describing it
## Make a change
### Set environment
Make sure you're running Node.js 20 or later.
```bash
node --version
@ -28,7 +30,12 @@ npx playwright install
Playwright is a multi-package repository that uses npm workspaces. For browser APIs, look at [`packages/playwright-core`](https://github.com/microsoft/playwright/blob/main/packages/playwright-core). For test runner, see [`packages/playwright`](https://github.com/microsoft/playwright/blob/main/packages/playwright).
Note that some files are generated by the build, so the watch process might override your changes if done in the wrong file. For example, TypeScript types for the API are generated from the [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src).
### TypeScript Type Generation
If your changes involve `TypeScript types`, ensure to modify the corresponding files in [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src).
Note that some files are generated by the build, so the watch process might override your changes if done in the wrong file. For example, TypeScript types for the API are generated from this directory.
### Linting
Coding style is fully defined in [.eslintrc](https://github.com/microsoft/playwright/blob/main/.eslintrc.js). Before creating a pull request, or at any moment during development, run linter to check all kinds of things:
```bash