.. mode: -*- rst -*-

Review checklist
================

:Tag: guide.review
:Status: incomplete documentation
:Author: Gareth Rees
:Organization: Ravenbrook Limited
:Date: 2015-08-10
:Revision: $Id$
:Copyright: See section `Copyright and License`_.
:Index terms: pair: review; checklist


Introduction
------------

_`.scope`: This document contains a list of checks to apply when
reviewing code or other documents in the Memory Pool System.

_`.readership`: This document is intended for reviewers.

_`.example`: The "example" links are issues caused by a failure to
apply the checklist item.

_`.diff`: Some items in the checklist are particularly susceptible to
being ignored if one reviews only via the version control diff. These
items refer to this tag.


Checklist
---------

_`.test`: If a new feature has been added to the code, is there a test
case? Example: job003923_.

.. _job003923: https://www.ravenbrook.com/project/mps/issue/job003923/

_`.unwind`: If code has been updated in a function that unwinds its
state in failure cases, have the failure cases been updated to
correspond? Example: job003922_. See `.diff`_.

.. _job003922: https://www.ravenbrook.com/project/mps/issue/job003922/



Document History
----------------

2015-08-10  GDR_  Created.

.. _GDR: https://www.ravenbrook.com/consultants/gdr/


Copyright and License
---------------------

Copyright © 2015–2020 `Ravenbrook Limited <https://www.ravenbrook.com/>`_.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
