Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Comment on

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

Last night's Perlmongers meeting was fun -- in September, we do Lightning Talks (not strictly limited to five minutes), which give everyone a chance to do a mini-presentation.

The discussion after Olaf Alder's presentation on Code::TidyAll touched on how to insure that developers only committed and checked in code that passed certain style rules. I'm curious to find out what my fellow monks feel about that.

At my last job, I was the git administrator, and I set up git hooks for some of the important repositories such that the commit message would be searched for a JIRA ticket number. If found, the script used the JIRA API to update that ticket with information about the commit, including a link to the commit (via gitweb). Theoretically, each commit should have had a JIRA ticket number, but if one wasn't found, the git hook script just output a message reminding the developer that their commit should have included an issue number.

I could have just disallowed the git push command altogether, forcing the developer game the system by using a fake JIRA number (ABC-1234) or perhaps some unrelated ticket number, but I wanted to avoid having the developers try to game the system in order to get their work into the repository. (I should also mention that the build system pulled only from the repository.)

What are your thoughts? How far should the revision control system go to enforcing a particular style and level of documentation?

Alex / talexb / Toronto

Thanks PJ. We owe you so much. Groklaw -- RIP -- 2003 to 2013.


In reply to Setting boundaries in software development by talexb

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!
  • 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
  • Outside of code tags, you may need to use entities for some characters:
            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?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others taking refuge in the Monastery: (17)
    As of 2014-08-27 17:00 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The best computer themed movie is:











      Results (246 votes), past polls