From 165896e335787db0c017322f1812a4df62d3d98e Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Sun, 27 Oct 2024 00:04:11 -0400 Subject: [PATCH] Add note about first-person comments --- Coding Guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Coding Guide.md b/Coding Guide.md index f065bf46..e8f55676 100644 --- a/Coding Guide.md +++ b/Coding Guide.md @@ -291,6 +291,8 @@ This section contains information on code standards regardless of which part of - Comments should be expressive and fully explain what is being described. Try to avoid using slang, "pointed comments" such as "you should" or "we do". +- Comments should avoid the use of first-person writing, such as "I think" or "We found". + - If comments include links, they can either be included as-is or using the `` tag ```c#