Expert Code Review best practices
Download as PPTX, PDF0 likes49 views
Code review is a software quality assurance activity where one or more reviewers examine source code changes to verify code quality, find bugs, and ensure it follows best practices. Key roles include the author who created the code and the reviewer who examines it. Code reviews help reduce bugs and technical debt, improve code readability and consistency, and allow code to be better maintained over time by different developers. Best practices for code reviews include automating reviews when possible, using checklists, providing timely and respectful feedback, and being open to follow up questions.
Expert Code Review best practices
- 2. What is Code Review ? Code review (sometimes referred to as peer review) is a software quality assurance activity in which one or several people check a program mainly by viewing and reading parts of its source code. At least one of the persons must not be the code’s author. The persons performing the checking are called “reviewers”.
- 3. The Roles Found In Code Review Process There are at least two roles that are always present in a code review:- •The author, who is responsible for creating the code being reviewed •The reviewer, who is the person responsible for examining the code and reporting the results to the author. The code review process can occur over a large network of programmers and debuggers or can be a shared task among a small group of developers. Use Code Review Checklists •Omissions can be the hardest defects to find because it´s difficult to review something that isn´t there. •Checklists help eliminate frequently made errors and deal with the challenges of omission finding. •Code review checklists also help members clear expectations for each type of review and can be helpful to find errors for reporting and process improvement purposes.
- 4. Why we need Code Review? Let understand why we need standard and best practices for Code Review? •Project Cost : 40%–80% of the lifetime cost of a piece of software goes to maintenance. •Maintenance : Hardly any software is maintained for its whole life by the original author. •Code readability : Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly. Enhance code-readability to anybody wanting to do so in the future reducing efforts for code maintenance •If you ship your source code as a product, you need to make sure it is as well packaged and clean as any other product you create. •Consistency : Introduce consistency to coding practices across length and breadth of implementations. •Code-reusability : Introduce code-reusability to repeatable processes and procedures. •Significantly reduce development time and effort, improving productivity. •Minimize POF’s (point of failure) during implementations. •Tech dept : It help in tech debt prevention.
- 12. Code Review Best Practices Code review is one of the important process in any software development. It should be properly documented so team can follow code review best practices. Let see some of the code review best practices. 1.Automate as much as possible using PMD or other tools 2.Decide on code review goals 3.Follow a common check list when submitting for review. 4.During review 1.Respond in a timely fashion 2.Set clear expectations 3.Aim to resolve the review quickly. 5.Compile your review : Be respectful and frame feedback as request not comments 6.Be open to follow-up
- 13. THANK YOU Like the Video and Subscribe the Channel