What makes a good code review

I've recently started a new software engineering role and performed my first code review a few days ago.

What is a code review?

A code review is an activity carried out by software engineers, consisting of checking someone else's code and looking out for any mistakes.

Once software engineers have finished coding (tests included), the next step is to submit their code for a code review.

When performing a code review, there are some aspects to consider to ensure that the code review is conducted successfully for you and your team members.

Memory and security

Is the code efficient both in terms of runtime and memory? Is the code secure? Code efficiency is essential because you want the code to be highly performant and reliable. For example, look for redundant code and ensure that errors and exceptions are handled consistently throughout the code.

Input

Is the input validated correctly? Certain parameters can only accept specific inputs. For example, can you accept negative values?

K.I.S.S. principle (Keep It Simple Stupid)

This software design principle states that designs, solutions, systems, and products work best if they’re kept simple. It means we should favor simplicity over complexity and avoid complexity as much as possible.[Baeldung]

Is there any more straightforward solution to the problem? Keeping the code as simple as possible is a great software engineering practice. Look for multiple if statements, over-complicated patterns, complex loops, etc. Take any chance to make the code understandable and straightforward.

To achieve KISS:

Write smaller programs.
Remove unused methods and instances.
Write readable code.

Readability

Is the code readable and well-formatted? The code should be written so whoever comes later can easily understand what is happening. Check if variables are named appropriately and eliminate unnecessary spaces and tabs.

Did the developer pick good names for everything? A good name is long enough to fully communicate what the item is or does, without being so long that it becomes hard to read.[What to look for in a code review]

Look at the pull request and ensure the code is always cleaner than before. See if you can use better programming concepts to improve the quality of the code. Even the slightest improvement can make a massive difference.

Conclusion

A code review is a collaborative task that benefits you and your team. Try to make it as constructive and pragmatic as possible. Give feedback to encourage improvement and explain why specific changes can benefit the code.

I hope you've found this helpful!

The Traits Of A Good Code Review

Comments (1)

Software Engineering

14 Most Recommended Programming Habits for Software Developers

More from this blog

OpenCode VS Gemini: Which One To Choose?

How To Use AI and Data To Make Better Decisions

How to Write Better Technical Content: A Beginner’s Guide

How To Maximize LinkedIn for Job Search

Elements of Technical Writing

What is a code review?

Memory and security

Input

K.I.S.S. principle (Keep It Simple Stupid)

Readability

Conclusion

Command Palette

Comments (1)

Software Engineering

14 Most Recommended Programming Habits for Software Developers

More from this blog

What is a code review?

Memory and security

Input

K.I.S.S. principle (Keep It Simple Stupid)

Readability

Conclusion