Hi Martin,

On Aug 16, 2012, at 11:27 AM, Martin Desruisseaux wrote:

> Hello all
> 
> Le 16/08/12 13:05, Mattmann, Chris A (388J) a écrit :
>>> 1. Eventually merge the sis-parent/pom.xml file with the root pom.xml file, 
>>> for simplifying a little bit the system.
>> Fine by me if you can make it work out the same way it currently does.
> I presume that the goals to preserve are "compile", "test", "install", 
> "site", "deploy" and "release"? The only goal I don't know about is 
> "release"; I never used that one - I always do my releases by hand in order 
> to check - and often fix - any step. Does Apache SIS uses it?

Yep we use:

mvn release:prepare
mvn release:perform

To make releases of our software. The Maven2 release plugin automatically tags,
and transforms Pom release versions and GPG signs and uploads artifacts to the
Apache Nexus server at https://repository.apache.org/. Since it is one of the 
approved
Forges for Maven Central, it is then synced to Central and made part of the 
Maven2
repo there for everyone.

> 
> In the main time I provided a patch for a skeleton Citation implementation:
> 
> https://issues.apache.org/jira/browse/SIS-55
> 
> This is a very incomplete implementation; I trimmed many functionalities in 
> order to focus the discussion on smaller items. Some items that may be worth 
> to discuss are:

Awesome, I will review it hopefully tomorrow or later this evening. Specific 
comments
below:

> 
> * Coding convention: I noticed that the other SIS Java classes use a
>   2-spaces indentation instead of the usual 4. How do peoples feel
>   about that? (note: I'm a supporter of 2-spaces indentation in XML
>   files, especially ISO 19139 XML files which tend to be very depth.
>   But I was used to stick to the more usual convention for Java code...)

I'm OK to use 4. Do you use Eclipse? If so, could you help make an
Eclipse profile that we could put up on our SIS wiki for devs to share?
If not, I can always make one for those Eclipse users like me out there:

https://cwiki.apache.org/confluence/display/SIS/Home

> * Standard Javadoc tags:
>     o @author: I propose "First name Last name (Institution)". Any though?

Fine by me. I'm not a stickler for stuff like this. Consistency is important, 
but
if folks aren't consistent, that's fine too. I like your suggestion though!

>     o @version: Personally, I don't use that for the file version.
>       Instead I use it for the last project version in which this file
>       got a significant change. This allow the user to know if
>       upgrading his Apache SIS dependency may brings a change in the
>       behaviour (including bug fixes) of this class. Any though?

Yeah I'm fine with removing these if you see them. They don't really add
much.

>     o @since: the project version when the file were first introduced,
>       completed by the provenance when the file started somewhere
>       else. Example: "@since 0.3 (derived from geotk-2.5)".

Yeah I do that or a combination of JIRA issue ids, like

@since SIS-xx SIS-yy

> * Custom Javadoc tags: @module, @preformat, @section, @note. They
>   require a custom doclet (not yet provided in the proposed patch). Do
>   peoples feel okay with creating a module (e.g. sis-build) that
>   provides only tools for building SIS? This module would include
>   doclets for the above-cited tags, optional pack200 on JAR files and
>   other stuff like that.

Sure that's fine by me I'm not super familiar with having done that before
but I can watch what you do and then learn and I'm willing to help maintain it.

> 
> 
> There is other issues raised by the proposed patch, but I guess we can start 
> by the above ones...

Yep. What do others think?

Cheers,
Chris

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: [email protected]
WWW:   http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Reply via email to