Code Reviews

Learning Objectives Differentiate between stylistic, logical, and security-related feedback in a code review. Formulate constructive, specific, and actionable comments on a piece of code. Identify at least three common 'code smells' such as magic numbers, long methods, and non-descriptive names. Explain the purpose of a style guide and apply its rules during a review. Analyze a code change to ensure it is efficient and maintainable. Use the 'praise-suggest-praise' sandwich method for delivering feedback kindly. Ever built something with LEGOs and had a friend suggest a better way to make it stronger? That's what a code review is for your programs! 🧐 In this lesson, we'll move beyond just finding typos and bugs. We'll learn the advanced ar...

TermDefinitionExample Code SmellA 'code smell' is not a bug, but a hint in the code that suggests a deeper problem. It's a sign that the code could be simplified or designed better.A very long function that does ten different things is a code smell. It suggests the function should be broken down into smaller, more focused functions. RefactoringThe process of restructuring existing computer code—changing the internal structure—without changing its external behavior. The goal is to improve the code's design, making it easier to read and cheaper to maintain.Renaming a variable from `x` to `player_score` is a simple refactor. It doesn't change what the program does, but it makes the code much easier to understand. Style GuideA set of rules for how to write and format...

The 'Why', Not Just the 'What' When suggesting a change, explain *why* it's better. Link to a style guide, explain the performance benefit, or describe how it improves readability. Use this rule to make your feedback educational, not just critical. It helps the author learn and prevents arguments by providing objective reasons for your suggestions. Be Specific and Actionable Avoid vague comments. Instead of 'This is confusing,' write 'This variable name `data` is not descriptive. Could we refactor it to `user_profile_list` to clarify what it contains?' Apply this rule to every comment you write. The author should know exactly what you are referring to and have a clear idea of how to address your feedback. Automate the Small St...