Skip to content

Code review in GitLab

Context and Problem Statement

Code reviews are a critical part of the software development process. They help ensure code quality, catch bugs early, share knowledge across the team, and maintain consistency in the codebase. GitLab provides built-in tools for managing code reviews through Merge Requests (MRs).

Merge requests allow teams to review code changes and discuss modifications before they are added to the main codebase, helping to ensure the quality and reliability of the code.

  • The current development process lacks a standardized code review workflow.
  • Code changes are sometimes merged without sufficient peer review, leading to potential quality issues.
  • There is no clear record of who reviewed the code and what feedback was provided.

Decision Outcome

Chosen option: "GitLab's Merge Request (MR) feature" because,

  • All changes to the main branch must go through a Merge Request.
  • At least one approval from a designated reviewer is required before merging.
  • Reviewers will follow a set of guidelines to ensure consistency and thoroughness.
  • GitLab CI/CD pipelines will run automated tests, linting, and other checks before allowing a merge.
  • Review comments and approvals will be documented within the MR for future reference.

Consequences

Positive:

  • Improved code quality due to peer review.
  • Increased team collaboration and knowledge sharing.
  • Clear accountability through documented reviews.

Negative:

  • Additional time required for reviews, which may slow down the development process initially.
  • Potential bottlenecks if reviewers are not available in a timely manner.

More Information

In GitLab, developers can create merge requests to propose changes they have made to a repository and request that those changes be reviewed and merged into the main branch by other team members.

The GitLab code review workflow is simple.

  1. Push your changes to GitLab using a terminal or the GitLab interface,
  2. Open a merge request from your terminal or the GitLab interface,
  3. Request reviewers to approve your merge request,
  4. (optional) If you have set up CI/CD automation, wait for the green light before merging,
  5. Reviewers will approve your merge request or request changes, change your code accordingly,
  6. If all required reviewers have approved the merge request, you can now safely merge if there is no conflict with the base branch.