I'm a little nervous about writing this, as it's my first node, and I wasn't sure if it should go in Seekers or Q&A. I hope I chose wisely.

  I guess it all started when grep posted something in the chatterbox about becomming a saint. From his node I found How You (Yes You!) Can Get Involved, which got me thinking. I've wanted to contribute in some way, but haven't known how, and this seemed just the ticket.

 I decided to review code that I am already somewhat familiar with as a jumping off point. I've decided to review YaBB. Maybe it needs it, maybe it doesn't, but it's a start, and it's not so huge a project that I wouldn't know where to begin.

  I do code reviews at work occasionally, and we have templates that we use which simplify the process by showing what should be checked, and provide a concise way to report back.

  Our template is for VB/Pick BASIC. It won't really work for this.

  So I set out to look for something like this on perlmonks. Alas... It's been talked about here, here, here, and no doubt other nodes.

  I found a lot of great points, and some lists of what to look for, but it seemed that nobody had ever pulled it all together and made any hard decisions on what to look for, and what format to submit the information in.

  This is my desire. I'd like to see the above. Something all of us could use as a standard for reviewing code. A Perlmonks standard, if you will.

  My feeling is that there needs to be perhaps three levels of code review:

  1.  A simple review, which just touches on basic items such as use strict and warnings.
  2.  A second level which goes a little more in-depth, covering things like use of CGI and other modules where appropriate as well as basic security.
  3.  Finally, a full review, which would include everything mentioned above, but to much more rigid standards.

  We all have differing amounts of time that we can devote to projects like this. When we do decide to help out in this manner, it would be great to have a template to use as a starting point, modify it as appropriate, and go from there.

  Am I missing something that's already out there, or perhaps my first mission to give back to the community should be to push for and assist in the making of the above? Is there someone who's already got something like this worked up that could be shared with the rest of us?

  Hoping for a yes to the above.



Nuke
nuke@nuke3d.com
www.nuke3d.com

In reply to Formal code review specifications and reporting format by Nuke

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.