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