Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Like many others, I'm very impressed with what you've written. I see it as a survey of the things we might possibly want to consider when doing reviews and such.

I recently worked in an organization which had a requirement of tool-assisted review for every piece of code that went into version control. I can say for certain that a much smaller list would be more useful for focusing reviews.

Picking a single coding standard that everyone can work with is a very good idea. Separate from that a (short) checklist of things to be aware of when reviewing is helpful.

Were I beginning this kind of a process (again), I'd probably start with your list and start paring them down. Anything that everyone does already (or strongly agrees with) does not really need to be on the checklist. Anything that everyone agrees with and tries to do should be on the list. Start with the low-hanging fruit. What gives the most advantage with the least disagreement?

In my experience, the bigger the list the more likely to generate one of two reactions:

  • "That's nice." and everyone ignores it
  • "I disagree with this one little nit, so I won't do it."

Generating a shorter checklist from your overall list is less likely to trigger either of these reactions.

The great thing about your list, for me at least, is that it gives a broad overview from which someone could pick what is important for their group.

G. Wade

In reply to Re: On Coding Standards and Code Reviews by gwadej
in thread On Coding Standards and Code Reviews by eyepopslikeamosquito

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, 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, 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.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others having an uproarious good time at the Monastery: (1)
    As of 2018-07-21 10:06 GMT
    Find Nodes?
      Voting Booth?
      It has been suggested to rename Perl 6 in order to boost its marketing potential. Which name would you prefer?

      Results (446 votes). Check out past polls.