-
-
Notifications
You must be signed in to change notification settings - Fork 26.6k
08. Reviewing pull requests
Ilkka Seppälä edited this page Jul 4, 2020
·
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
status:under reviewbadge to the pull request - If the issue is not mentioned in the pull request, mention it. That way it's easy to later link back to the PR.
- Check that the code compiles and the existing tests succeed (CI 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?
- Is the pattern-
README.mdimplemented correctly so the pattern will show correctly on the web site? - 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.