Jump to: navigation, search

Difference between revisions of "Poppy/Developer - Review Guidelines"

(Created page with "* Docstrings are updated if needed * Commit messages reflect bps, bugs if applicable (https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes)")
 
(Poppy Code Review Guidelines)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
=== Poppy Code Review Guidelines===
 +
 +
Below are 'some' of the things to watch out for during code reviews. Please update this list as you come across new ones.
 +
 
* Docstrings are updated if needed
 
* Docstrings are updated if needed
 
* Commit messages reflect bps, bugs if applicable (https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes)
 
* Commit messages reflect bps, bugs if applicable (https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes)
 +
* No trailing whitespaces :)
 +
* Keep in mind the design priniciples
 +
# YAGNI http://en.wikipedia.org/wiki/You_aren't_gonna_need_it
 +
# DRY http://en.wikipedia.org/wiki/Don%27t_repeat_yourself

Latest revision as of 20:19, 10 November 2014

Poppy Code Review Guidelines

Below are 'some' of the things to watch out for during code reviews. Please update this list as you come across new ones.

  1. YAGNI http://en.wikipedia.org/wiki/You_aren't_gonna_need_it
  2. DRY http://en.wikipedia.org/wiki/Don%27t_repeat_yourself