News for hackers. Stuff that matters.
Re:Ask HN: What tone to use in code review suggestions? by justinram11 on Friday June 24, 2022 @05:11AM (#31859367)
[Suggestion] Use conventional comments[1] to flag how important the comment is.

Most of my comments end up being "suggestions", but then when I put a [blocking] on it, it clearly communicates that I think this should be fixed before merging in.

1: https://conventionalcomments.org/

Re:Ask HN: What tone to use in code review suggestions? by ra7 on Monday June 27, 2022 @11:58AM (#31896414)
Using conventional comments also forces me to rethink if my comment is really blocking or is just an optional suggestion and I can adjust the tone accordingly.
Re:Ask HN: What tone to use in code review suggestions? by cubes on Monday June 27, 2022 @02:20PM (#31898503)
+1 for use of Conventional Comments. It's a simple lift for a noticeable improvement in clarity, and guidance on what to do next.
Re:Ask HN: What tone to use in code review suggestions? by Deradon on Monday June 27, 2022 @06:09PM (#31901508)
Offtopic but related:

Conventional commits: https://www.conventionalcommits.org/en/v1.0.0/

Re:Ask HN: What tone to use in code review suggestions? by djadmin on Monday June 27, 2022 @01:22PM (#31897708)
I use conventional comments everyday. It just helps me communicate clearly and concisely.
Re:Ask HN: What tone to use in code review suggestions? by amrox on Monday June 27, 2022 @02:13PM (#31898428)
praise: I came here to suggest conventional comments as well!
Re:Ask HN: What tone to use in code review suggestions? by imiric on Monday June 27, 2022 @05:22PM (#31900986)
thought: reading this style of sentence would get annoying quickly.

I don't get the point of these TBH. The usefulness of conventional commits is that they can be easily aggregated to get an idea of the types of changes that were made.

Code review comments are purely meant for human communication, so requiring a specific structure is both annoying to write and to read.

I tend to use one, at most two prefixes. "Nit", and rarely "blocker". Though I'd rather specify if something is a blocker once I make my case about what needs to be changed.

Every other comment is assumed to be a suggestion, and depending or not I block the PR by "requesting changes", it's up to the author to either accept my suggestion or provide reasons not to.

Any other strict guideline about how to write prose is silly to me. Especially the decorations section. C'mon now.