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

docs: fix some English in CONTRIBUTING.md (#9641)

Browse source
This commit is contained in:
Subramani 2021-10-21 08:29:12 -04:00 committed by GitHub
parent 7626e881ac
commit fb69ff30a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -67,7 +67,7 @@ When authoring new API methods, consider the following:
- Expose as little information as needed. When in doubt, don’t expose new information. - Expose as little information as needed. When in doubt, don’t expose new information.
- Methods are used in favor of getters/setters. - Methods are used in favor of getters/setters.
- The only exception is namespaces, e.g. `page.keyboard` and `page.coverage` - The only exception is namespaces, e.g. `page.keyboard` and `page.coverage`
- All string literals must be small case. This includes event names and option values. - 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. - Avoid adding "sugar" API (API that is trivially implementable in user-space) unless they're **very** common.
### Commit Messages ### Commit Messages
@ -99,14 +99,14 @@ Example:
``` ```
fix(firefox): make sure session cookies work fix(firefox): make sure session cookies work
This patch fixes session cookies in firefox browser. This patch fixes session cookies in the firefox browser.
Fixes #123, fixes #234 Fixes #123, fixes #234
``` ```
### Writing Documentation ### Writing Documentation
All API classes, methods and events should have description in [`docs/src`](https://github.com/microsoft/playwright/blob/master/docs/src). There's a [documentation linter](https://github.com/microsoft/playwright/tree/master/utils/doclint) which makes sure documentation is aligned with the codebase. All API classes, methods, and events should have a description in [`docs/src`](https://github.com/microsoft/playwright/blob/master/docs/src). There's a [documentation linter](https://github.com/microsoft/playwright/tree/master/utils/doclint) which makes sure documentation is aligned with the codebase.
To run the documentation linter, use: To run the documentation linter, use: