Semantic Code Reviews – Simple and direct comments without drama
1–10 of 49 posts
Re: Semantic Code Reviews – Simple and direct comments without drama
#2The blog post explores the idea that code review comments should be more than just polite and respectful – they should convey their intent clearly and effectively. As developers, we're well aware of the complexity of code, and communication around it should be streamlined and efficient.
Semantic comments come with labels that convey their purpose, whether it's a simple remark, a question seeking an answer, a hint for future consideration, a suggestion open for discussion, an important point requiring change, or a crucial issue that must be addressed.
Re: Semantic Code Reviews – Simple and direct comments without drama
#3Nice post. However, imho with a good enough writing style it should be possible to convey the purpose of the text without an explicit label.
Re: Semantic Code Reviews – Simple and direct comments without drama
#4From my experience, the challenge of a good review lies less on the how to convey but more on the capacity to set the cursor between a suggestion and an important remarks.
Re: Semantic Code Reviews – Simple and direct comments without drama
#5Nice post. However, imho with a good enough writing style it should be possible to convey the purpose of the text without an explicit label.
I tend to agree with that, however don't understand the language barrier. Labeling comments makes the intent unambiguous.
I also enjoy a tactical use of smileys and other emojis where applicable :)
Re: Semantic Code Reviews – Simple and direct comments without drama
#6Nice post. However, imho with a good enough writing style it should be possible to convey the purpose of the text without an explicit label.
Thank you for your comment. Your experience leads me to believe that the concept might be more useful for non-native speakers. The labels have helped us shorten lengthy PR discussions and focus on the factual aspects. For context: I work in a German company with an international team, and we use English as our business language
Re: Semantic Code Reviews – Simple and direct comments without drama
#7I've been a big fan of this approach for years (introduced to me by Conventional Comments [1]) - even though it may not always be necessary, it's a low-effort way to make sure you're not misunderstood.
Re: Semantic Code Reviews – Simple and direct comments without drama
#8Nice post. However, imho with a good enough writing style it should be possible to convey the purpose of the text without an explicit label.
This "good enough writing style" must also be able to cross cultural borders - I dare to say even journalists don't get it right most of the time:
* I've heard Kiwis say "F*ck you?" in lieu of "Seriously?"
* A Brit who says "That is an interesting solution!" usually does not feel intellectually stimulated by the solution but is conveying that it is utter garbage.
Thus, I very much like the proposed idea of well-defined labels.*
Re: Semantic Code Reviews – Simple and direct comments without drama
#9Nice post. However, imho with a good enough writing style it should be possible to convey the purpose of the text without an explicit label.
Anything that avoids ambiguity here is beneficial. Even if the comment itself is perfectly crafted, the potential for misunderstanding remains. This method outlines the expectations for responses much more than it conveys the tone of the message. This is critical information that is often overlooked in asynchronous communication.
Re: Semantic Code Reviews – Simple and direct comments without drama
#10I've been a big fan of this approach for years (introduced to me by Conventional Comments [1]) - even though it may not always be necessary, it's a low-effort way to make sure you're not misunderstood. [1] https://conventionalcomments.org/
I'd previously tried Conventional Commits but I found the number of labels they suggest too many to keep in my head. The labels in post map well to how I think about comments.