From 636d97207f94a9ec38765787ca4b126d642b8beb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Han?= Date: Fri, 21 Mar 2025 17:08:02 +0100 Subject: [PATCH] docs: propose new contribution guidance (#1750) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # What does this PR do? Propose new contribution guidance. Signed-off-by: Sébastien Han --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 505d6b162..e3eaa470c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,9 +135,11 @@ uv sync ## Coding Style +* Comments should provide meaningful insights into the code. Avoid filler comments that simply describe the next step, as they create unnecessary clutter, same goes for docstrings. +* Prefer comments to clarify surprising behavior and/or relationships between parts of the code rather than explain what the next line of code does. +* Catching exceptions, prefer using a specific exception type rather than a broad catch-all like `Exception`. +* Error messages should be prefixed with "Failed to ..." * 4 spaces for indentation rather than tabs -* 80 character line length -* ... ## Common Tasks