Skip to Content.
Sympa Menu

comanage-dev - Re: [comanage-dev] Updated Coding Guidelines

Subject: COmanage Developers List

List archive

Re: [comanage-dev] Updated Coding Guidelines


Chronological Thread 
  • From: Benn Oshrin <>
  • To: comanage-dev <>
  • Subject: Re: [comanage-dev] Updated Coding Guidelines
  • Date: Sat, 17 Dec 2011 20:51:15 -0500

On 12/16/11 3:17 PM, Marie Huynh wrote:
If we're going back to fix old code anyway, why not do it all at the
same time and run it through one of these formatters before tagging?

http://coding.smashingmagazine.com/2007/07/12/time-savers-code-beautifier-and-formatter/

Sure, they won't fix everything, but it's better than doing it all by hand.

Here are my thoughts on this...

I don't have a moral objection to using one of these, and if anyone wants to, by all means go ahead.

I think all code commits (not just tagged releases) should be properly formatted. It's too easy to introduce bugs after testing otherwise, especially if we're relying on automated formatters. It's best to test stuff while the test cases are still fresh in your mind.

Furthermore, I suspect if we defer reformatting, it'll never happen, and the codebase will become even more disjoint than it already is.

On top of that, if there are problems with the new guidelines, we should discover them sooner rather than later.

I'm sensitive to concerns about falling behind schedule, but there are only about 20 rules encoded in the new guidelines. It should take maybe an hour to do the reformatting, and going forward the incremental cost should be trivial.

-Benn-



Archive powered by MHonArc 2.6.16.

Top of Page