doc/HACKING/HowToReview.md

   1 How to review a patch
   2 =====================
   3
   4 Some folks have said that they'd like to review patches more often, but they
   5 don't know how.
   6
   7 So, here are a bunch of things to check for when reviewing a patch!
   8
   9 Note that if you can't do every one of these, that doesn't mean you can't do
  10 a good review!  Just make it clear what you checked for and what you didn't.
  11
  12
  13 Top-level smell-checks
  14 ----------------------
  15
  16 (Difficulty: easy)
  17
  18 - Does it compile with `--enable-fatal-warnings`?
  19
  20 - Does `make check-spaces` pass?
  21
  22 - Does `make check-changes` pass?
  23
  24 - Does it have a reasonable amount of tests?  Do they pass?  Do they leak
  25   memory?
  26
  27 - Do all the new functions, global variables, types, and structure members have
  28  documentation?
  29
  30 - Do all the functions, global variables, types, and structure members with
  31   modified behavior have modified documentation?
  32
  33 - Do all the new torrc options have documentation?
  34
  35 - If this changes Tor's behavior on the wire, is there a design proposal?
  36
  37 - If this changes anything in the code, is there a "changes" file?
  38
  39
  40 Let's look at the code!
  41 -----------------------
  42
  43 - Does the code conform to CodingStandards.txt?
  44
  45 - Does the code leak memory?
  46
  47 - If two or more pointers ever point to the same object, is it clear which
  48   pointer "owns" the object?
  49
  50 - Are all allocated resources freed?
  51
  52 - Are all pointers that should be const, const?
  53
  54 - Are `#defines` used for 'magic' numbers?
  55
  56 - Can you understand what the code is trying to do?
  57
  58 - Can you convince yourself that the code really does that?
  59
  60 - Is there duplicated code that could be turned into a function?
  61
  62
  63 Let's look at the documentation!
  64 --------------------------------
  65
  66 - Does the documentation confirm to CodingStandards.txt?
  67
  68 - Does it make sense?
  69
  70 - Can you predict what the function will do from its documentation?
  71
  72
  73 Let's think about security!
  74 ---------------------------
  75
  76 - If there are any arrays, buffers, are you 100% sure that they cannot
  77   overflow?
  78
  79 - If there is any integer math, can it overflow or underflow?
  80
  81 - If there are any allocations, are you sure there are corresponding
  82   deallocations?
  83
  84 - Is there a safer pattern that could be used in any case?
  85
  86 - Have they used one of the Forbidden Functions?
  87
  88 (Also see your favorite secure C programming guides.)