-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Review guidelines
Jirka Borovec edited this page May 12, 2020
·
12 revisions
Some recommended steps for reviewing open PRs.
- Check the source issues if the fix solves it
- Read the changes if they are aligned with our code-base
- Check if the changes (fixed issue, new feature) are covered by tests
- Check if the change is mentioned in CHANGELOG (no need for typos, docs and CI)
- If you checked all the above points, you may approve the PR in your review or request changes. Only approve it if you are confident that the issue or feature is fully addressed, otherwise leave a comment with your concerns. The actual
mergify
automation is set for N approvals so each approval matter and you shall be confident with your action... the rule of the tongue says:- Approve: if you completely agree with the content to be merged as it is now (no extra condition in comments)
- Comment: not sure in any direction (your understanding, affect in global, etc.) but you want to express your opinion about a specific point
- Request changes: if you are sure that the actual change will break something or has obvious issues
Remember that if you approve a PR and it reaches the minimum number of required approvals and given that all tests pass, the branch will be automatically merged into master.
- be nice and constructive, remember your fist PR and what helped you / made you motivated to continue contributing
- use suggestions for simple edits when you know what it shall be instead of leaving a long description (you can still add a short justification of your proposal) so the author can simply accept it.