Skip to content
This repository has been archived by the owner on May 7, 2020. It is now read-only.

Review Checklist

Kai Kreuzer edited this page Aug 24, 2018 · 2 revisions

Although we have coding guidelines and JavaDocs on the APIs, there are mistakes that are regularly done by new contributors in PRs, which often slip through the reviews.

This page should serve as a quick checklist for reviewers to remember what to look for to make sure that those things are addressed by the contributors.

This should be a living document, so every committer/reviewer is free to add stuff to the list, which he regularly notices in reviews.

Checklist

  1. proper bundle name ("Eclipse SmartHome ...")
  2. EPLv2 (LICENSE instead of about.html, up-to-date headers)
  3. all dependencies must be listed in LICENSE file
  4. conservative use of log levels (mainly debug, unless bugs to report or misconfiguration other than on things)
  5. Thing/Channel labels should be short and capitalized
  6. no channels that are static
  7. handler.initialize() to return fast and set a valid/correct Thing status
  8. use of lambdas for runnables
  9. include new bundles in build, p2 feature and karaf feature
  10. Handle REFRESH commands