1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.. highlight:: none


.. index::
   pair: review; checklist

.. _design-guide.review:


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

.. mps:prefix:: guide.review


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

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

:mps:tag:`readership` This document is intended for reviewers.

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

:mps:tag:`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
---------

:mps:tag:`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/

:mps:tag:`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 :mps:ref:`.diff`.

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