2 ms·
To speak to the point about the PR comments, it's quite tricky to get a sense of the intention behind them. In the last few years I have adopted the approach of
by martinwheeler 3y ago
To speak to the point about the PR comments, it's quite tricky to get a sense of the intention behind them. In the last few years I have adopted the approach of conventional comments, which has helped a lot with conveying that intention.
I.e. if I want clarity around a code choice it's clear to the developer that I need more context, or if I have a nitpick to point out it's clear that that's why I am pointing it out. I think everyone should comment in this style as it helps to shed light on what you're trying to express, even if the comment is short or unintentionally snarky.
https://conventionalcomments.org/ https://conventionalcomments.org/
Of course this doesn't address all the forms of text communication but PRs are generally a pain point when it comes to interpreting meaning.
- wigunarrr 3y agoWow, I never seen such thing as conventional comments. I went further and found conventional commits, it was pretty good. Thank you for sharing!