docs: clarify use of comments in contributions

This commit is contained in:
Adam Gastineau 2024-12-06 09:02:24 -08:00
parent 733f9a2926
commit 06de8e8e7f

View file

@ -35,7 +35,7 @@ Coding style is fully defined in [.eslintrc](https://github.com/microsoft/playwr
npm run lint 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 ### Write documentation