Skip to content

08. Reviewing pull requests

Ilkka Seppälä edited this page Nov 13, 2016 · 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

  • Assign the pull request to yourself
  • Put under review badge to the pull request
  • Check that the code compiles and the existing tests succeed
  • 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)?
  • Is the class diagram generated correctly?
  • Is the pattern-README.md implemented correctly so the pattern will show correctly on the web site?
  • Is the originator of the design pattern properly credited?

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