Update code review guidelines (#683)

On my current client project we have been using labels as a prefix to comments we leave on code reviews to clearly display intention and tone. This removes a lot of ambiguity from written text which can be interpreted in many ways. Our usage of labels has been informed by this article https://conventionalcomments.org/. This PR would bring this optional way of working to other people within thoughtbot.
thoughtbot · Jun 30, 2023 · 74f40f5 · 74f40f5
1 parent 1973625
commit 74f40f5
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/code-review/README.md b/code-review/README.md
@@ -32,7 +32,7 @@ that covers this material from [Derek Prior at RailsConf
 
 - Be grateful for the reviewer's suggestions. ("Good call. I'll make that
   change.")
-- Be aware that it can be [challenging to convey emotion and intention online]
+- Be aware that it can be [challenging to convey emotion and intention online], you may want to consider [using labels] to convey intention and tone.
 - Explain why the code exists. ("It's like that because of these reasons. Would
   it be more clear if I rename this class/file/method/variable?")
 - Extract some changes and refactoring into future tickets/stories.
@@ -49,6 +49,7 @@ that covers this material from [Derek Prior at RailsConf
 - Final editorial control rests with the pull request author.
 
 [challenging to convey emotion and intention online]: https://thoughtbot.com/blog/empathy-online
+[using labels]: https://conventionalcomments.org/
 
 ## Reviewing Code