maven-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Vincent Siveton" <vincent.sive...@gmail.com>
Subject Re: [DISCUSS] Maven Team Conventions
Date Sat, 05 Jul 2008 13:21:17 GMT
Hi,

2008/7/5, Brett Porter <brett@apache.org>:
> Just a couple of comments...
>
>  code.apt:
>  ~~ * Using SVN properties like \$Id: \$ => Is it a wanted goal for all
> files like java or apt?
>  I think this is helpful, though maybe optional. I don't really think it's

We can start to include it in all new files.

> good for the @version tag in Javadoc though.

Personally, I am in favour to use @version $Id:$ in javacode. The
important tag is @since.

>   * <<Indentation>>: Always use 2 space indents and <<never>>
use tabs!
>  The two space rule is only for text files, right? We use 4 for Java in all
> indents, but the document doesn't indicate that.

Fixed

>   * <<Readingness>>: Specify code grouping members, if needed. For instance
> in a Mojo class, you could have:
>  I've found these are used inconsistently and get out of date. Like all
> comments, someone should add them if they think they'll help, but as a
> general rule I'd omit this.
>

Do we want to improves the readability of the code by sorting members?
If so, any recommended layout?

>  jira.apt:
>
>  I disagree on JIRA issues - for making release notes and keeping track I
> think it's best to have an issue whenever possible.
>

Other comments?

Cheers,

Vincent

>  BTW, I posted some conventions to this list in the past, maybe we could
> incorporate them:
> http://markmail.org/message/wfv2lw66i2gggnaq
>
>  Thanks,
>  Brett
>
>
>
>  On 04/07/2008, at 7:00 AM, Vincent Siveton wrote:
>
>
> >
> > Hi folks,
> >
> > Following recent discussions on dev@ about POM style [1] and Jira
> > versioning [2], I created several documents about our code style and
> > conventions, jira and svn conventions.
> >
> >
> http://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/developers/conventions
> >
> > It is for discussions and all comments are welcome :)
> >
> > Cheers,
> >
> > Vincent
> >
> > [1]
> http://www.nabble.com/-Proposal--Pom-Code-Style-(WAS-svn-commit%3A-r670264----maven-plugins-trunk-maven-site-plugin-pom.xml)-td18083228.html
> > [2]
> http://www.nabble.com/Re%3A--jira--Updated%3A-(MNG-3468)-FileSet-needs-a-toString()-method-to-properly-print-in-debug-mode-td18185825.html
> >
> >
> ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
>
>  --
>  Brett Porter
>  brett@apache.org
>  http://blogs.exist.com/bporter/
>
>
> ---------------------------------------------------------------------
>  To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>  For additional commands, e-mail: dev-help@maven.apache.org
>
>

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


Mime
View raw message