hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: HC coding conventions and guidelines
Date Fri, 28 Dec 2012 20:57:25 GMT
Checkstyle is one thing but it would be good to document something in
the site, even if it is just "our coding conventions are described in
checkstyle.

Gary

On Dec 22, 2012, at 10:06, Oleg Kalnichevski <olegk@apache.org> wrote:

> Folks
>
> Some while ago there was an attempt made at compiling a list of coding
> conventions and guidelines for the project [1]. Unfortunately those
> efforts did not result in any concrete outcome other than a draft
> document.
>
> We have been getting more people on board in the past couple of months,
> which is a good thing. However, this makes more important that there is
> at least some simple but enforceable coding conventions in place.
>
> While I am between contracts I can find time to work on things I never
> managed to get around to in the past. I went ahead and added some very
> rudimentary stylecheck definitions to HttpCore trunk [2]. They are:
> mandatory ASLv2 header, maximum line length, checks for illegal and bulk
> (star) imports, no tabs and trailing white spaces.
>
> If you happen to like style checks (some people do) feel free to take a
> look at what is already there and add more (provided the source code is
> adjusted accordingly and the style checks pass).
>
> I am going to add similar stuff to HttpClient and HttpAsyncClient in the
> coming days.
>
> Cheers
>
> Oleg
>
> [1] http://wiki.apache.org/HttpComponents/CodingConventions
> [2]
> http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/hc-checkstyle.xml
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Mime
View raw message