Code review is known to be an effective way to improve software quality, foster peer learning and develop common ownership of a research software project. In practice, a code review is nothing else than a conversation between the author of the code and somebody else providing feedback on coding practices, readability or other aspects of code quality. If this sounds straightforward, an effective code review routine can be tricky to establish. Here are five tips for you to get started with code reviews, or get more of them.
There are many reasons to do regular code reviews. One of them is improving the readability of your code. Source code is often the only documentation available for research software, and readability is, therefore, key to anyone trying to reproduce or build upon your research. Would you ever publish a paper without any feedback on its draft?
SSI Fellows Dominik Krzemiński, Thibault Lestang and Valerio Maggio are running a Code Review Workshop on Thursday 10 February for academics to learn how to perform good code reviews.
Subscribe to Thibault Lestang
What sources of information, experience and models of thinking do we need to bring together in the discussions about software sustainability? Which communities do we need to connect (to)?