diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md index 0d06365209..74e25cbf14 100644 --- a/docs/dev-process/coding-guidelines.md +++ b/docs/dev-process/coding-guidelines.md @@ -82,3 +82,11 @@ over runtime checks. We produce a single binary for all UNIX variants, so runtime checks are currently necessary for some platform differences, e.g. macOS and Linux. + +## Code comments + +It's strongly encouraged to add comments when you are making changes to the code and tests, +especially when the changes are not trivial or may raise confusion. +Make sure the added comments are accurate and easy to understand. +Good code comments would greatly improve readability of the code, and make it much more maintainable. +