From a56a5cabbd1c19acdff2a096fd0ee406ee56d3e9 Mon Sep 17 00:00:00 2001 From: Adam Gastineau Date: Fri, 6 Dec 2024 10:09:35 -0800 Subject: [PATCH] docs: clarify use of comments in contributions (#33896) --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb06a17e77..ebcabc8a27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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