Skip to content

08. Reviewing pull requests

Ilkka Seppälä edited this page Apr 1, 2018 · 28 revisions

Reviewing incoming pull requests is an open process where anyone can participate and give improvement suggestions. That being said, accepting a pull request can be done by a core team member. The general guidelines for code review are given below.

As a reviewer, you need to ensure

  • Add yourself as a reviewer
  • Put under review badge to the pull request
  • Check that the code compiles and the existing tests succeed (Travis build does this)
  • Does the example code implement the pattern correctly and follow good coding practices?
  • Does the example code have proper tests and enough test coverage?
  • Is the example code commented well enough?
  • Are the project coding conventions being followed (Checkstyle handles this and fails the build in case of deviations)?
  • Is the pattern-README.md implemented correctly so the pattern will show correctly on the web site? Are the code samples annotated correctly so that syntax highlighting works?
  • Is the originator of the design pattern properly credited?

Based on the checks above use the Github's review functionality to signal your acceptance/rejectance.

As a general guideline, pull requests with no activity during the last 30 days will be closed.