Jump to: navigation, search

Difference between revisions of "ReviewChecklist"

(Nova Review Checklist)
m
 
(22 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 +
#REDIRECT [http://docs.openstack.org/infra/manual/developers.html#peer-review OpenStack Infra Manual]
  
This page includes a list of things that reviewers should keep in mind when reviewing patches to [[OpenStack]] projects. There are some items that are common across all projects and others that are specific to a project.
+
The content of this page is now hosted on [http://docs.openstack.org/infra/manual/developers.html#peer-review OpenStack Infra Manual]
 
 
= Common Review Checklist =
 
 
 
# The code should comply with everything in [https://github.com/openstack/oslo-incubator/blob/master/HACKING.rst HACKING].
 
# When adding a new file:
 
## If it's not installed by setup.py, but should be included in the tarball, be sure to add it to `MANIFEST.in`.
 
# A single commit should be as small as is practicable while maintaining atomic functionality. If a commit message includes "and do this other thing", it should probably be split up. For more details on this, see [[GitCommitMessages]].
 
 
 
= Nova Review Checklist =
 
 
 
# When syncing from oslo:
 
## Ensure the proposed change has actually merged in oslo.
 
## It should provide some benefit, don't sync just to sync.  Maybe it fixes a bug, or provides new functionality to be used.  If providing new functionality it should have a dependent patch lined up to use that functionality.
 
#For ReST API changes:
 
## If an API sample test template changes, ensure the doc samples are also updated.
 
## The change should conform to [[APIChangeGuidelines]]
 
# When changing an RPC interfance
 
## Make sure the version numbers are updated appropriately and that backwards compatibility is maintained.  More info [https://github.com/openstack/oslo-incubator/blob/master/openstack/common/rpc/dispatcher.py#L18 here].
 
## If an existing method is being updated, make sure support for sending the old version of the method is still supported.  Search for existing uses of "can_send_version()" for examples.
 
 
 
= Notes for Non-Core Developers =
 
 
 
* When you are reviewing, you may notice a review that has several +1's from other reviewers, passes the functional tests, etc. but the code still has not been merged. As only core developers can approve code for merging, you can help things along by getting a core developer's attention and letting them know there is a review with lots of positive reviews and needs final approval.
 

Latest revision as of 01:45, 4 December 2014

#REDIRECT OpenStack Infra Manual

The content of this page is now hosted on OpenStack Infra Manual