Reviewing instructions
======================

Code reviews happen on the Elisa commits mailing list. A mail is sent
automatically for each commit in the Subversion repository.

Information on how to subscribe and archives can be found on the `elisa-commits
webpage`_.

.. _elisa-commits webpage: http://lists.fluendo.com/mailman/listinfo/elisa-commits

Reviewing code
--------------

Here are some steps that a reviewer should go through during a review:

- all public methods are documented (arguments, return value,
  exceptions)

  * Important: check that @raises are present if a method is likely to
    throw an exception
  * Important: add "MT safe." if the method can be called from
    multiple threads at the same time

- all public instance variables and class variables are documented
- Epydoc's generated documentation looks fine
- code style complies with the one explained in `coding style`_
- unit tests code coverage is reasonable (above 80% is a good indicator even
  though a manual checking of what is covered is important)
- FIXME should have been looked over; for big issues, tickets should be opened


When finished, check the maintainers listed are aware that they are
maintainers and optionally put your name next in a maintainer
variable: __maintainerX__

If something's really wrong in the reviewed code and if there's a
ticket associated with the review request, reopen the ticket on trac
and ping the review "requester", optionally slap him.

.. _coding style: /elisa/trac/wiki/CodingStyle
