All too often people can get so wound up that they forget that the outcome of their “discussion” has no bearing on their life expectancy, their salary, their chances to win x- factor, getting that dream date, winning the lottery, finding a cure for climate change or whatever it is they regard as important!
Similarly, in the world of software engineering code reviews can end up in pointless engagements of conflict. Developers can bicker over silly little things, offend each other and occasionally catch a bug that probably would have being caught in QA anyway – that conflict free zone around the corner!
Now don’t get me wrong, there are perfectly valid reasons why you may think code reviews are a good idea for your project:
- Catching bugs sooner means less cost to your project. You don’t have to release a fix patch because it’s has been caught in development phase – yippee!
- Code becomes more maintable. That crazy 200 line method that Jonny was writing with a hangover has being caughted before it has the chance to make itself at home deep in your code base.
- Knowledge is spread across your team. There are no longer large blocks of code that only one person knows about. And we all know, when that one person talks about taking a two month holiday everyone panics!
- Developers make more of an effort. If a developer knows someone else is going to pass judgement on his work, he’s more likely to put that line of javadoc to clarify when an exception will be thrown.
- 1. Never forget TDD
- 2. Automate as much you can
- 3. Respect Design
- 4. Agree a style guide (and a dictionary)
- 5. Get the right tooling
If all your developers are using Eclipse (and happy using it) something like Jupiter makes sense. You can navigate your way through code, debug code and essentially leverage everything the Eclipse IDE does to make your life looking at code easier when reviewing code. However, if everyone is not on the same IDE (or the IDE is not making your life easier) consider something like Review Board.
- 6. Remember every Project is different.
You may have done something in a previous project that worked. But remember, every project is different. The other project had a certain architecture (may have been highly concurrent, highly distributed), had a certain culture (everyone may have enjoyed using eclipse) and used certain tools (maven or ant). Does the new one tick the same boxes? Remember, different things work for different projects.
- 7. Remember give and take
- 8. Be buddies
- Problems are caught very early
- You are always up to speed as to what is going on
- Reviews are always very short because you are only looking at new code since the last catch up
- Because the setting is informal – there is no nervous tension. They’re fun!
- You can exchange ideas – regularly.
In summary, if your project is going to engage in code reviews, they should be fast, effective and not waste people’s time. As argued in this post, it is really important to think about how they are organised to ensure that does not happen.
‘Til the next time – take care of yourselves.
This guide will introduce you to the world of Software Architecture!
This 162 page guide will cover topics within the field of software architecture including: software architecture as a solution balancing the concerns of different stakeholders, quality assurance, methods to describe and evaluate architectures, the influence of architecture on reuse, and the life cycle of a system and its architecture. This guide concludes with a comparison between the professions of software architect and software engineer.