-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: update CONTRIBUTING.md #33138
Conversation
This comment has been minimized.
This comment has been minimized.
fd1306a
to
b0feb75
Compare
Test results for "tests 1"6 flaky35989 passed, 624 skipped Merge workflow run. |
The CONTRIBUTING guide is much easier to read now! Thanks for the update. :) 1. *namespace* is put in parenthesis after label and is optional. Must be lowercase.
1. *title* is a brief summary of changes.
1. *description* is **optional**, new-line separated from title and is in present tense.
1. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues.
|
@pengooseDev Thank you!
That's intentional, markdown handles it just right.
There is the following line currently, but it's not very prominent: If you have any specific ideas on improving the guide, I would love to review a PR! |
@dgozman This is just a tiny suggestion, so feel free to disregard it if it doesn't align with teams visions. :) Thx! Example### 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
npm run lint
|
No description provided.