In that spirit, I will call attention to your first sentence, specifically the comma. In my opinion, that can be improved. One of three other constructions would be more appropriate:
I am really happy when people are quite strict in code reviews. It makes me feel safer and I get to learn more.
I am really happy when people are quite strict in code reviews, because it makes me feel safer and I get to learn more.
I am really happy when people are quite strict in code reviews; it makes me feel safer and I get to learn more.
The first of my suggested changes is favoured by those who follow the school of thought that argues that written sentences should be kept short and uncomplicated to make processing easier for those less fluent. To me, it sounds choppy or that you’ve omitted someone asking “Why?” after the first sentence.
Personally, I prefer the middle one, because it is the full expression of a complete state of mind. You have a feeling and a reason for that feeling. There is a sense in which they are inseparable, so not splitting them up seems like a good idea. The “because” explicitly links the feeling and reason.
The semicolon construction was favoured by my grade school teachers in the 1960s, but, as with the first suggestion, it just feels choppy. I tend to overuse semicolons, so I try to go back and either replace them with periods or restructure the sentences to eliminate them. In this particular case, I think the semicolon is preferable to both comma and period, but still inferior to the “because” construction.
I’ve clearly spent too much time hashing stuff out in writers’ groups. :)
I agree with most of that. In formal settings, I prefer full sentences with conjunctions; however, choppy sentences are the ones that often end up in my Lemmy comments.
Reviews have to be balanced to circumstance. There is a big difference between putting out the sales brochure and the notice on the bulletin board. Likewise in coding a cryptographic framework for general consumption and that little script to create personal slideshows based on how you’ve tagged your photos.
As a general rule, wider distributions, public distributions, and long-lived distributions need more ambitious reviews. If the distribution is wide, public, and permanent, then everything needs very detailed scrutiny.
I have found some success in starting with and occasionally revisiting review goals. This helps create and maintain some consistency in a process that is scaled to the task at hand.
Correcting the reviewer.
Notes: “should of” isn’t valid, should implies a verb, of isn’t a verb. I expect you meant “should have”. Please recall this in future submissions.
They should of course keep that in mind, but it’s not that “should” should always be followed by a verb directly. The problem is that “of” in this context is a mishearing/spelling of “have”, so they should in this case have written it like that instead.
I would argue that “should of” is just a naive written rendition of the spoken contraction “should’ve”. They are homophones, so it’s a completely understandable error among those without the relevant education or background. I know only English and was in Grade 9 at a different school before someone corrected me.
A question mark does not fit the sentence, which is a statement (“they should.” rather than “should they?”). While question marks are commonly used to demonstrate a rising tone at the end of a sentence, its not considered correct for formal writing.
A-ha, but this most decidedly not formal writing! UNO REVERSE CARD.
But on a more serious note, I did intend it as a sort of question because I’m not 100% sure, because the rules for quote use might well be different in English than my native language. I actually also don’t know the rule for question mark usage in English; is it generally considered a crime against orthography to plonk a question mark on something that’s a statement, or is it valid in some cases?
It’s totally valid in most cases. It’s technically only supposed to be used for a question, but language is based on how it’s most commonly used, with those “rules” only applying in extremely formal situations. With the prevalence of informal text-based communication, many people use it to indicate being unsure, like how you used it. I just wanted to continue the chain of grammar corrections (which is why I used the wrong “its”/“it’s” at one point). Also, you were right about the quotes.
It’s technically only supposed to be used for a question, but language is based on how it’s most commonly used
Ah, I see you’re also a descriptivist 😀
But yeah I know you were just continuing the joke; I’m a language nerd (well, general nerd really) and I just got curious about what the rule actually is. While English orthography rules related to punctuation usually seem to be pretty much the same as with Finnish, the rule for question marks seems to be more relaxed in Finnish because it can “officially” be used to mark any expression as a question. The rules for commas are also different, ours are closer to German and we tend to spray commas everywhere
Notably, a good code review should also bring up the good parts of the submission, and not just concentrate on the errors. Not only does it make the recipient feel better to get positive feedback among the negative, but it helps them learn about good practices too. Just concentrating on the errors doesn’t really tell them which things they’re doing well.
Many reviewers concentrate on just finding mistakes, and while it’s useful it’s sort of the bare minimum; a good code review should be educational. Especially if the submitter’s a more junior coder, in which case it’d also be a good idea to not just outright tell them how you’d fix some problem, but sort of lead them to a solution by asking them questions and pointing things out and letting them do the thinking themselves. But still, experienced coders will also benefit from well-structured feedback, it’s not like we’re “finished” and stopped learning.
Yes, I tend to do that, and thankfully some of my colleagues do too. Clever but readable solutions, following good and relevant practices, clear documentation, making a good MR description that makes it easier to review, and more.
That’s great to hear. It’s thankfully becoming more common in general, and we can all do our part in spreading these practices.
I tended to actively evangelize for it when I was managing coders or teams. Unfortunately it’s still not all that uncommon for coders to be downright offensive when giving feedback, like not necessrily quite Linus-level rants but things like “this is idiotic, this is stupid, that’s shit, why would you do that” etc etc. The usual explanation I’ve gotten is that they’re just being “honest” and saying what they think, and it’s not their problem if the reviewee (is that even a word‽ I can’t English today) gets offended. Some even get all huffy about it, like “oh we’re just supposed to coddle them and never say anything negative so their little feefees don’t get hurt?” And I mean, yeah, getting honest feedback definitely a good way to learn, but it’s not like the only way to point out errors or problems is to be a cunt about it.
Yeah, I learn so much from code reviews and they’ve saved me so much time from dumb mistakes I missed. I’ve also caught no shortage of bugs in other people’s code that saved us all a stressful headache. It’s just vastly easier to fix a bug before it merges than once it breaks a bunch of people.
Assuming you have competent leadership, then it wouldn’t be merged if you missed something obvious. I guess you’re saying that you want more positive reinforcement.
I am really happy when people are quite strict in code reviews, it makes me feel safer and I get to learn more.
Nothing worse than some silent approvals with no real feedback. What if I missed something obvious… and now it’s merged.
To be fair, I also enjoy getting my grammar corrected. I’m juggling 3 languages and things can get messy.
In that spirit, I will call attention to your first sentence, specifically the comma. In my opinion, that can be improved. One of three other constructions would be more appropriate:
The first of my suggested changes is favoured by those who follow the school of thought that argues that written sentences should be kept short and uncomplicated to make processing easier for those less fluent. To me, it sounds choppy or that you’ve omitted someone asking “Why?” after the first sentence.
Personally, I prefer the middle one, because it is the full expression of a complete state of mind. You have a feeling and a reason for that feeling. There is a sense in which they are inseparable, so not splitting them up seems like a good idea. The “because” explicitly links the feeling and reason.
The semicolon construction was favoured by my grade school teachers in the 1960s, but, as with the first suggestion, it just feels choppy. I tend to overuse semicolons, so I try to go back and either replace them with periods or restructure the sentences to eliminate them. In this particular case, I think the semicolon is preferable to both comma and period, but still inferior to the “because” construction.
I’ve clearly spent too much time hashing stuff out in writers’ groups. :)
This is what I live for. :D
I agree with most of that. In formal settings, I prefer full sentences with conjunctions; however, choppy sentences are the ones that often end up in my Lemmy comments.
That only makes sense. We are having a conversation, not creating literature.
Strange, I get a mild hostility vibe from colleagues if I review too ambitiously.
Reviews have to be balanced to circumstance. There is a big difference between putting out the sales brochure and the notice on the bulletin board. Likewise in coding a cryptographic framework for general consumption and that little script to create personal slideshows based on how you’ve tagged your photos.
As a general rule, wider distributions, public distributions, and long-lived distributions need more ambitious reviews. If the distribution is wide, public, and permanent, then everything needs very detailed scrutiny.
I have found some success in starting with and occasionally revisiting review goals. This helps create and maintain some consistency in a process that is scaled to the task at hand.
Like the other guy, I also read your comment twice looking for mistakes but found none.
You should of left something to fix!
😏
Edit: I’m glad there so many people who are as passionate about the correct spelling of “should’ve” as I am. I was testing you all, and you passed!
Correcting the reviewer.
Notes: “should of” isn’t valid, should implies a verb, of isn’t a verb. I expect you meant “should have”. Please recall this in future submissions.
They should of course keep that in mind, but it’s not that “should” should always be followed by a verb directly. The problem is that “of” in this context is a mishearing/spelling of “have”, so they should in this case have written it like that instead.
I love that you used “should of” in a valid sentence.
Except that it would be “they should, of course,”.
I would argue that “should of” is just a naive written rendition of the spoken contraction “should’ve”. They are homophones, so it’s a completely understandable error among those without the relevant education or background. I know only English and was in Grade 9 at a different school before someone corrected me.
😏
“should” and “of” should probably be in quotes here?
A question mark does not fit the sentence, which is a statement (“they should.” rather than “should they?”). While question marks are commonly used to demonstrate a rising tone at the end of a sentence, its not considered correct for formal writing.
A-ha, but this most decidedly not formal writing! UNO REVERSE CARD.
But on a more serious note, I did intend it as a sort of question because I’m not 100% sure, because the rules for quote use might well be different in English than my native language. I actually also don’t know the rule for question mark usage in English; is it generally considered a crime against orthography to plonk a question mark on something that’s a statement, or is it valid in some cases?
It’s totally valid in most cases. It’s technically only supposed to be used for a question, but language is based on how it’s most commonly used, with those “rules” only applying in extremely formal situations. With the prevalence of informal text-based communication, many people use it to indicate being unsure, like how you used it. I just wanted to continue the chain of grammar corrections (which is why I used the wrong “its”/“it’s” at one point). Also, you were right about the quotes.
Ah, I see you’re also a descriptivist 😀
But yeah I know you were just continuing the joke; I’m a language nerd (well, general nerd really) and I just got curious about what the rule actually is. While English orthography rules related to punctuation usually seem to be pretty much the same as with Finnish, the rule for question marks seems to be more relaxed in Finnish because it can “officially” be used to mark any expression as a question. The rules for commas are also different, ours are closer to German and we tend to spray commas everywhere
Notably, a good code review should also bring up the good parts of the submission, and not just concentrate on the errors. Not only does it make the recipient feel better to get positive feedback among the negative, but it helps them learn about good practices too. Just concentrating on the errors doesn’t really tell them which things they’re doing well.
Many reviewers concentrate on just finding mistakes, and while it’s useful it’s sort of the bare minimum; a good code review should be educational. Especially if the submitter’s a more junior coder, in which case it’d also be a good idea to not just outright tell them how you’d fix some problem, but sort of lead them to a solution by asking them questions and pointing things out and letting them do the thinking themselves. But still, experienced coders will also benefit from well-structured feedback, it’s not like we’re “finished” and stopped learning.
Yes, I tend to do that, and thankfully some of my colleagues do too. Clever but readable solutions, following good and relevant practices, clear documentation, making a good MR description that makes it easier to review, and more.
That’s great to hear. It’s thankfully becoming more common in general, and we can all do our part in spreading these practices.
I tended to actively evangelize for it when I was managing coders or teams. Unfortunately it’s still not all that uncommon for coders to be downright offensive when giving feedback, like not necessrily quite Linus-level rants but things like “this is idiotic, this is stupid, that’s shit, why would you do that” etc etc. The usual explanation I’ve gotten is that they’re just being “honest” and saying what they think, and it’s not their problem if the reviewee (is that even a word‽ I can’t English today) gets offended. Some even get all huffy about it, like “oh we’re just supposed to coddle them and never say anything negative so their little feefees don’t get hurt?” And I mean, yeah, getting honest feedback definitely a good way to learn, but it’s not like the only way to point out errors or problems is to be a cunt about it.
We Americans like to forget that anyone might have any trouble understanding English especially in cases of polyglots.
I don’t know which is your native tongue but from this comment it looks like you’re doing a fine job.
Yeah, I learn so much from code reviews and they’ve saved me so much time from dumb mistakes I missed. I’ve also caught no shortage of bugs in other people’s code that saved us all a stressful headache. It’s just vastly easier to fix a bug before it merges than once it breaks a bunch of people.
Assuming you have competent leadership, then it wouldn’t be merged if you missed something obvious. I guess you’re saying that you want more positive reinforcement.