DEV Community

Cover image for Giving and Receiving Great Code Reviews

Giving and Receiving Great Code Reviews

Sam Jarman 👨🏼‍💻 on June 25, 2017

Taking part in code reviews has been one of the most interesting learning experiences in my career. I’ve done some really dumb stuff and I’ve learn...
Collapse
 
t4rzsan profile image
Jakob Christensen • Edited

Great article. It made me change how to write commit messages.

But I wonder why you call it "imperative mood" (I am Danish so English is not my first language and I am quite possibly completely wrong)? Chris Beams writes in his blog that you should be able to use your commit message in the sentence "If applied, this commit will ...". But that is not imperative mood. That is called future tense (I think).

I don't think it actually makes a difference in English but in Danish grammar there is a difference in wording between imperative mood and in future tense. So now I am in doubt what is the best way to write commit messages :-).

Collapse
 
samjarman profile image
Sam Jarman 👨🏼‍💻

I'm no expert in english terms, but I use the "If applied, this commit will ...".

Generally, it means drop the "s"

"Change x" (Not "changes x")
"Add x to y" (Not "Adds x to y")

Collapse
 
brian_minard profile image
brian

This captures the essence of code review really well--shared ownership, common standards and discussion are all critical to code quality.

Describing code reviews this way, reenforces the notion of the code base being a shared resource for the entire team. I think that's an important idea for teams to embrace.

Collapse
 
peeke91 profile image
Peeke Kuepers

Nice article Sam :)

Two small typos: 'the what changes' at the beginning of paragraph 4 and 'maybe be' instead of 'may be' somewhere.

Collapse
 
samjarman profile image
Sam Jarman 👨🏼‍💻

Nice Grant! We also do PR templates too, to formalise the points I outlined in the post. They're helpful so far, but must help the process rather than hinder