Browse Source

New chapter: code reviews are not for style

master
Julio Biason 5 years ago
parent
commit
04ae4f8b97
  1. 1
      content/books/things-i-learnt/_index.md
  2. 32
      content/books/things-i-learnt/code-reviews-style/index.md
  3. 2
      content/books/things-i-learnt/right-tool-obvious/index.md

1
content/books/things-i-learnt/_index.md

@ -63,3 +63,4 @@ template = "section-contentless.html"
* [Understand And Stay Away From Cargo Cult](cargo-cult) * [Understand And Stay Away From Cargo Cult](cargo-cult)
* ["Right Tool For The Job" Is Just To Push An Agenda](right-tool-agenda) * ["Right Tool For The Job" Is Just To Push An Agenda](right-tool-agenda)
* [The Right Tool Is More Obvious Than You Think](right-tool-obvious) * [The Right Tool Is More Obvious Than You Think](right-tool-obvious)
* [Code Reviews Are Not For Style](code-reviews-style)

32
content/books/things-i-learnt/code-reviews-style/index.md

@ -0,0 +1,32 @@
+++
title = "Things I Learnt The Hard Way - The Right Tool Is More Obvious Than You Think"
date = 2019-07-16
[taxonomies]
tags = ["en-au", "books", "things i learnt", "code reviews", "code style"]
+++
When doing code reviews, do not focus on style; focus on design things that
look a bit weird.
<!-- more -->
Code reviews are designed to spread knowledge around the team, with focus on
construction and problem description. Does the sequence of code gives you an
understanding on what it is trying to do? Does it contains something you know
it will make things harder to read in the future? Does it miss the point?
That's the things you should focus.
If the author of the code missed a space here, left a blank line there...
that's of no consequence in a code review. This is not the thing to discuss in
the code review.
And people _hate_ people who go through code reviews just to point
missing/extra spaces and lines.
On the other hand, if you find something weird in the code which is something
you want the author to recheck, _then_ you're free to comment that "it would
be good" if they fix the style. But that's it.
{{ chapters(prev_chapter_link="/books/things-i-learnt/right-tool-obvious", prev_chapter_title="The Right Tool Is More Obvious Than You Think") }}

2
content/books/things-i-learnt/right-tool-obvious/index.md

@ -26,4 +26,4 @@ One of the reason your hero project may fail is because of this: You may even
prove that what you thought it was a better solution is actually a better prove that what you thought it was a better solution is actually a better
solution, but it can't be applied 'cause nobody else can maintain it. solution, but it can't be applied 'cause nobody else can maintain it.
{{ chapters(prev_chapter_link="/books/things-i-learnt/right-tool-agenda", prev_chapter_title="Right Tool For The Job Is Just To Push An Agenda") }} {{ chapters(prev_chapter_link="/books/things-i-learnt/right-tool-agenda", prev_chapter_title="Right Tool For The Job Is Just To Push An Agenda", next_chapter_link="/books/things-i-learnt/code-reviews-style", next_chapter_title="Code Reviews Are Not For Style") }}

Loading…
Cancel
Save