Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 1.26 KB

PULL_REQUEST_GUIDELINES.md

File metadata and controls

19 lines (13 loc) · 1.26 KB

Pull Request (PR) Guidelines

Submitting a Pull Request for Review

Small, Atomic Changes

Each Pull Request should ideally focus on one single issue or feature. Avoid including unrelated changes. Break down larger changes into smaller, more manageable, and understandable units.

Be Descriptive

Clearly explain the purpose and context of the Pull Request. Provide a concise summary of the changes made, why they are necessary, and any relevant information that can help reviewers understand the intention behind the code changes.

Review Your Changes

Ensure that the code changes have been thoroughly tested and do not introduce new issues. We recommend opening a draft pull request to help you review your PR.

Optimize the Reviewers' Time

Ensure that "All checks have passed", that you've tested and reviewed your PR, and that the description and checklist are properly filled before assigning reviewers. Ask for reviews on complete PRs, not drafts.

Respond to Reviews

Address any concerns or questions raised by reviewers and make necessary adjustments to your code as suggested. Keep the Pull Request up to date with the latest changes.