<?xml version="1.0" encoding="windows-1252"?>
<node id="692787" title="How should I do (and document) effective semi-formal code review?" created="2008-06-18 16:12:04" updated="2008-06-18 12:12:04">
<type id="115">
perlquestion</type>
<author id="375088">
radiantmatrix</author>
<data>
<field name="doctext">
&lt;p&gt;I think of myself as a moderately good developer.  I have a reasonable
amount of experience, I know about common patterns, I reuse code when possible,
I try to follow good development practice.

&lt;p&gt;I use test-driven development, I religiously use a revision control systsem.
I use [cpan://Devel::Cover] to check that my tests cover 100% of the code I 
write.  Likewise, I ensure that I have good [cpan://Pod::Coverage]. 

&lt;p&gt;I've done informal code reviews before -- at many of my clients, my 
co-workers disdained code review, so I found ways to do it "on the sly": "Hey,
I'm not sure about this module, would you look at it with me?"

&lt;p&gt;Now, though, I have an opportunity to do more structured and formal code
review.  I don't want to bury the process in formality and paperwork, but it is
important that I can point a manager at documentation and say "yep, I 
&lt;em&gt;really&lt;/em&gt; did code reviews, here's the proof".

&lt;p&gt;Can the members of the Monestary suggest:&lt;ol&gt;
  &lt;li&gt;Ground rules for having useful code reviews
  &lt;li&gt;Ideas for what kinds of documentation I should have to prove they've been
  done
  &lt;li&gt;Any other information about conducting semi-formal code reviews in a way
  that's really useful for developing (esp. in Perl).
&lt;/ol&gt;

&lt;p&gt;I'd certainly benefit from the experience of my esteemed brothers and sisters.

&lt;!-- 
&lt;p&gt;&lt;small&gt;&lt;b&gt;Updates:&lt;/b&gt;&lt;ul type='square'&gt;
&lt;li&gt;date : desc&lt;/li&gt;
&lt;/ul&gt;&lt;/small&gt;&lt;/p&gt;
--&gt;

&lt;div class="pmsig"&gt;&lt;div class="pmsig-375088"&gt;
&lt;small&gt;
&lt;small&gt;&lt;font color='#000000'&gt;&amp;lt;&lt;/font&gt;&lt;font color='#1a1a1a'&gt;&amp;ndash;&lt;/font&gt;&lt;font color='#343434'&gt;r&lt;/font&gt;&lt;font color='#4e4e4e'&gt;a&lt;/font&gt;&lt;font color='#686868'&gt;d&lt;/font&gt;&lt;font color='#828282'&gt;i&lt;/font&gt;&lt;font color='#9c9c9c'&gt;a&lt;/font&gt;&lt;font color='#b6b6b6'&gt;n&lt;/font&gt;&lt;font color='#d0d0d0'&gt;t&lt;/font&gt;&lt;font color='#eaeaea'&gt;.&lt;/font&gt;&lt;font color='#d0d0d0'&gt;m&lt;/font&gt;&lt;font color='#b6b6b6'&gt;a&lt;/font&gt;&lt;font color='#9c9c9c'&gt;t&lt;/font&gt;&lt;font color='#828282'&gt;r&lt;/font&gt;&lt;font color='#686868'&gt;i&lt;/font&gt;&lt;font color='#4e4e4e'&gt;x&lt;/font&gt;&lt;font color='#343434'&gt;&amp;ndash;&lt;/font&gt;&lt;font color='#1a1a1a'&gt;&amp;gt;&lt;/font&gt;&lt;/small&gt;
&lt;!--&amp;lt;-&lt;/small&gt;&lt;b&gt;radiant&lt;/b&gt;.&lt;b&gt;matrix&lt;/b&gt;&lt;small&gt;-&amp;gt;&lt;/small--&gt;
&lt;br&gt;&lt;a href='http://radiantmatrix.org/'&gt;Ramblings and references&lt;/a&gt;
&lt;br&gt;&amp;ldquo;A positive attitude may not solve all your problems, but it will annoy enough people to make it worth the effort.&amp;rdquo; — &lt;em&gt;Herm Albright&lt;/em&gt;
&lt;br&gt;&lt;em&gt;I haven't found a problem yet that can't be solved by a well-placed [http://en.wikipedia.org/wiki/Trebuchet|trebuchet]&lt;/em&gt;
&lt;/small&gt;
&lt;/div&gt;&lt;/div&gt;</field>
</data>
</node>
