geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Kevan Miller <kevan.mil...@gmail.com>
Subject Re: Writing Readable Code
Date Mon, 18 Sep 2006 16:33:10 GMT

On Sep 18, 2006, at 11:17 AM, Paul McMahan wrote:

> I agree that readability is a huge factor in code quality and is a key
> to its survival.  But I tend to disagree that a commit should be
> rejected based on this criteria alone. IMHO the low bar for committing
> to trunk should be that it compiles, does no harm, and has undergone
> adequate discussion within the dev community.  Providing adequate
> comments lies just outside that threshold as something that you should
> expect to be nagged heavily about but not necessarily vetoed.  Like
> you say, in most cases this will be resolved through simple
> discussion.

I'd certainly want to see issues resolved via discussion. We can  
certainly try that, initially.

However, I think we should acknowledge that if the code isn't  
commented at commit (or very soon afterwards), the code will most  
likely never be commented...

--kevan 

Mime
View raw message