yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify use of comments in contributions (#33896)

Browse Source
This commit is contained in:
Adam Gastineau 2024-12-06 10:09:35 -08:00 committed by GitHub
parent 733f9a2926
commit a56a5cabbd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -35,7 +35,7 @@ Coding style is fully defined in [.eslintrc](https://github.com/microsoft/playwr
npm run lint
```
Comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory.
Comments should have an explicit purpose and should improve readability rather than hinder it. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory.
### Write documentation