diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4975338088be2..e728fecfcbb3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,11 +30,6 @@ 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). -### 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. - ### Write documentation Every part of the public API should be documented in [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src), in the same change that adds/changes the API. We use markdown files with custom structure to specify the API. Take a look around for an example. @@ -43,6 +38,11 @@ Various other files are generated from the API specification. If you are running Larger changes will require updates to the documentation guides as well. This will be made clear during the code review. +### TypeScript Type Generation + +If your changes involve `TypeScript types`, ensure to modify the corresponding files in [`utils/generate_types`](https://github.com/microsoft/playwright/blob/main/utils/generate_types). +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: