Skip to content

Review guidelines

Adrian Wälchli edited this page May 12, 2020 · 12 revisions

Some recommended steps for reviewing open PRs.

  1. Check the source issues if the fix solves it
  2. Read the changes if they are aligned with our code-base
  3. Check if the changes (fixed issue, new feature) are covered by tests
  4. Check if the change is mentioned in CHANGELOG (no need for typos, docs and CI)
  5. 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. Note that if you approve and the PR reaches the minimum number of required approvals, and given that all tests pass, the branch will be automatically merged into master.

Hints and remarks

  • 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.
Clone this wiki locally