Skip to content

PR Approval Guidelines

Overview

This document outlines the guidelines and process for approving Pull Requests (PRs) in the project.

Approval Process

  1. Code Review: Every PR must undergo a thorough code review by at least one team member.
  2. Unit Tests: All unit tests associated with the changes in the PR must pass successfully.
  3. Code Coverage: While not mandatory, maintaining or increasing code coverage is encouraged.
  4. Functional Testing: If applicable, the changes should be tested for functionality.
  5. Documentation: Ensure that any new features or changes are appropriately documented.
  6. Adherence to Coding Standards: The code should follow the project's coding standards and best practices.

Reviewers

  • PRs must be reviewed by at least one designated reviewer or by any team member.

Approval

  • Once the above criteria are met, the PR can be approved and merged into the main branch.

Exceptions

  • In certain cases, exceptions to these guidelines may be made based on the discretion of the team lead or senior team members.

Feedback

  • Feedback on PRs should be constructive and aimed at improving the overall quality of the codebase.

Conclusion

By adhering to these guidelines, we aim to maintain the quality and stability of the project while fostering collaboration and continuous improvement.