Talk:02 Code Review and Approval Procedure

Introduction

• Purpose: Establish a standardized process for reviewing and approving code changes to maintain quality, catch issues early, and ensure audit traceability using tools like Git.

• Scope: Covers all code changes in software projects across development teams, focusing on Git-based repositories.

• Objectives: Enforce coding standards, reduce bugs, promote collaboration, and keep detailed records for internal audits.

• Key Terms:
  • Git: Version control system for tracking code changes.
  • Branching: Creating separate code lines (e.g., feature branches) in Git.
  • Pull Request (PR): Git mechanism for proposing and reviewing code changes.
  • Reviewer: Assigned team member who evaluates the PR.

• Standards: Align with company coding guidelines and audit requirements for traceability.

• Audience: Developers, reviewers, team leads, and auditors.

• How to Use: Follow this for all code changes; store in Confluence for access.

2. Roles and Responsibilities

• Key Roles:
  • Developer: Makes code changes, runs tests, creates PRs.
  • Reviewer: Reviews PRs, adds comments, approves or requests changes.
  • Team Lead: Assigns reviewers, resolves issues, ensures process adherence.

• Developer Tasks:
  • Use Git for branching and code changes.
  • Run test cases before creating PRs.
  • Act on reviewer comments and update PRs.

• Reviewer Tasks:
  • Review code, add comments on issues.
  • Re-review updates until PR is approved.

• Team Collaboration:
  • Use Slack #code-reviews for notifications.
  • Link PRs to Jira tickets for tracking.