News for hackers. Stuff that matters.
Re:Semantic Code Reviews – Simple and direct comments withou... by alexmolas on Monday August 14, 2023 @06:23AM (#37119371)
Nice 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 withou... by osmsucks on Monday August 14, 2023 @06:54AM (#37119542)
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 withou... by osmsucks on Monday August 14, 2023 @11:22AM (#37122068)
Argh, I meant "however don't underestimate". I blame mobile keyboards and their autocorrect features.
Re:Semantic Code Reviews – Simple and direct comments withou... by kmschaal on Monday August 14, 2023 @06:58AM (#37119565)
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 withou... by jlg23 on Monday August 14, 2023 @07:29AM (#37119787)
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 withou... by gcanyon on Monday August 14, 2023 @07:59AM (#37120025)
Where I come from (western US) that would be "f*ck me?" I think "interesting" has become the universal anodyne term for dismissal.
Re:Semantic Code Reviews – Simple and direct comments withou... by throwaway290 on Monday August 14, 2023 @08:20AM (#37120187)
That's modern social media and even then partly.

If in work setting your coworkers (god forbid teamleads or managers) interact like that just run, don't try to solve it with conventional reviews or something. Believe me you will not finish blinking before they start misusing this too to cope with their repressed anger through mockery/shallow sarcasm. "nitpick: have you considered escaping user input?"

Re:Semantic Code Reviews – Simple and direct comments withou... by avgcorrection on Monday August 14, 2023 @10:00AM (#37121118)
> 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.

I can be sarcastic but I have never directed sarcasm towards someone who I am reviewing. (Sarcasm towards third-party code is okay for me.)

I don't know if people who are using sarcasm would want to start labeling things like that as such, since it tends to detract from the intended effect.

Disclaimer: not a Brit.

Re:Semantic Code Reviews – Simple and direct comments withou... by Cthulhu_ on Monday August 14, 2023 @10:30AM (#37121459)
Well yeah, but in those examples the commenters do not use direct or clear language, they use colloquialisms and passive-aggressive remarks; if you avoid those, a lot of problems with cultural difference are already resolved.
Re:Semantic Code Reviews – Simple and direct comments withou... by chrisfowles on Monday August 14, 2023 @07:30AM (#37119793)
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 withou... by gcanyon on Monday August 14, 2023 @07:57AM (#37120008)
The label takes a fraction of a second to type, and saves the reader(s) many seconds spent inferring what purpose the writer had.

The label makes it easy to find comments still in need of replies, and for automated security to prevent merging items with outstanding crucial comments.

The label opens the possibility of automated reporting and/or review of reviews.

Re:Semantic Code Reviews – Simple and direct comments withou... by JimDabell on Monday August 14, 2023 @08:00AM (#37120036)
Unfortunately, it’s extremely common for less senior people to interpret suggestions from more senior people as instructions to be followed even if they aren’t worded as such. Having a consistent, explicit, and unambiguous way of distinguishing between these scenarios that everybody on the team can follow easily is valuable. You can’t rely upon all developers to be good writers or even good readers, especially across language barriers.
Re:Semantic Code Reviews – Simple and direct comments withou... by treis on Monday August 14, 2023 @09:15AM (#37120679)
Eh, suggestions from more senior people are in practice instructions. The risk in ignoring them is that something comes back to bite you and you look like an idiot for not following the suggestion of the senior.
Re:Semantic Code Reviews – Simple and direct comments withou... by IIsi50MHz on Monday August 14, 2023 @09:36PM (#37129112)
Not necessarily. It depends on culture (local or otherwise). A senior needs to carefully instill an understanding of when a suggestion is optional; for some seniors, this may be "never". I personally prefer when direct instructions are mandatory but anything framed as a suggestion allows personal discretion (and requires willingness to defend having not followed the suggestion).
Re:Semantic Code Reviews – Simple and direct comments withou... by ahoka on Monday August 14, 2023 @10:13AM (#37121258)
This is the real problem. Sometimes questions are also taken as instructions.
Re:Semantic Code Reviews – Simple and direct comments withou... by Cthulhu_ on Monday August 14, 2023 @10:32AM (#37121478)
As a senior, you should be aware of the authority you have or that others perceive you have. Your comments will be perceived as authoritative and coming from experience.

And they might very well be! But just make sure you get a rapport with the reviewed party, and prefix or suffix the comment with a "just a suggestion" or an explicit "I'm not asking you to act on this remark". With a semantic review, you can shorten it to "nit:".

Re:Semantic Code Reviews – Simple and direct comments withou... by cantSpellSober on Thursday August 17, 2023 @12:25PM (#37164118)
> prefix or suffix the comment with a "just a suggestion"

That's what the article suggests, using "Suggestion:" as a prefix.

> or an explicit "I'm not asking you to act on this remark"

Same, the article suggests the "Remark:" prefix. Both are more terse than what you suggest here.

Re:Semantic Code Reviews – Simple and direct comments withou... by flashgordon on Monday August 14, 2023 @11:06AM (#37121878)
I agree. For example just prepending "Question" to a sentence ending in a "?" did not convey anything more to me. Worse the Question that this OP posted in his example could have actually been constructed in a safer manner if safety was what this environment was most under threat. I did sense there was a need to robotify humans and sure enough the "Source" confirmed it (Google Software Engineering Practices)!