You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by Steve Loughran <st...@iseran.com> on 2001/04/04 19:50:36 UTC

[SUBMIT] first pass at a task guidelines/process document.

This is something I started in my spare time a couple of days ago, a better
document covering the process and the style for submitting new tasks and
patches to ant.

The checklists at the bottom are probably one of the key benefits -they list
what should be done for someone new to the process. I also cover the issues
of GPL licensing, test cases and documentation.

Where it is incomplete is

-needs more detail on helper classes, classes to extend from

-more on how to write ant tests (i.e. some simple examples for people that
dont know Junit)

-a list of what the recommended names for attributes and elements should be.

The latter kind of depends on ant2.0 and the proposal to unify naming
better. Should it be 'src' or 'source'? Will failonerror be an aspect or
something each task must write? These are still undecided issues. Maybe I
should just mention that these are still up in the air and just recommend
consistency with other tasks.

Comments? Contributions to where the doc is incomplete?

-steve



Re: [SUBMIT] first pass at a task guidelines/process document.

Posted by Stefan Bodewig <bo...@apache.org>.
Steve Loughran <st...@iseran.com> wrote:

> From: "Stefan Bodewig" > <bo...@apache.org>

>> To run the tests, the target is run-tests, not test.
> 
> oh. I use use test because of
>  <target name="test" depends="run-tests"/>

Oops, should read our own build file from time to time 8-)

> Attached revised version. Added caveat about helper functions being
> 1.x only; pulled out the 'recommended parent classes' completely.

OK, thanks a lot. I'll look over (and commit) it.

Stefan

Re: [SUBMIT] first pass at a task guidelines/process document.

Posted by Steve Loughran <st...@iseran.com>.
----- Original Message -----
From: "Stefan Bodewig" <bo...@apache.org>
To: <an...@jakarta.apache.org>
Sent: Thursday, April 05, 2001 03:11
Subject: Re: [SUBMIT] first pass at a task guidelines/process document.



> To run the tests, the target is run-tests, not test.  There is a
> run-single-test target which makes running individual tests a lot
> easier than running against an individual build file (which will not
> work anyway IMHO).

oh. I use use test because of
 <target name="test" depends="run-tests"/>


> Getting to your Checklist: Another benefit of testcases is, that they
> make the committers more confident in code contributions. At least I
> feel a lot better if I don't have to rely on my two eyes only when
> reviewing code.
>
> I prefer patches sent as attachments, as some mailers break lines in
> the body of a mail and make the patch unusable (at least without
> manual intervention).
>
> Checklist for new tasks: patch to defaults.properties and either
> coretasklist.html or optionaltasklist.html.

done.

Attached revised version. Added caveat about helper functions being 1.x
only; pulled out the 'recommended parent classes' completely.

While I am at it, I should announce that my final gold release of my lecture
on modern development problems and processes is now up on the web :
http://www.iseran.com/Steve/modern_development_processes.html
Ant is covered as part of the bigger problem of getting stuff out the door
approximately on time.

-steve




Re: [SUBMIT] first pass at a task guidelines/process document.

Posted by Stefan Bodewig <bo...@apache.org>.
Steve Loughran <st...@iseran.com> wrote:

> This is something I started in my spare time a couple of days ago, a
> better document covering the process and the style for submitting
> new tasks and patches to ant.

I really like it, thanks.

Some first comments:

I wouldn't list MatchingTask as a "good task to derive from" as I
prefer tasks to support explicit filesets - one of the key points is,
that you can have multiple filesets if you use explicit ones.

You should probably add a big disclaimer on top of the helper section,
saying that this applies to Ant1 only.  I don't expect Project to keep
any of the helper methods currently implemented there.

Add "no tabs" to the coding standard section.

When you point people to the current testcases, you should do so with
a grain of salt, most testcases are, uhm, rudimentary. 8-)

To run the tests, the target is run-tests, not test.  There is a
run-single-test target which makes running individual tests a lot
easier than running against an individual build file (which will not
work anyway IMHO).

Getting to your Checklist: Another benefit of testcases is, that they
make the committers more confident in code contributions. At least I
feel a lot better if I don't have to rely on my two eyes only when
reviewing code.

I prefer patches sent as attachments, as some mailers break lines in
the body of a mail and make the patch unusable (at least without
manual intervention).

Checklist for new tasks: patch to defaults.properties and either
coretasklist.html or optionaltasklist.html.

Stefan

Re: [SUBMIT] first pass at a task guidelines/process document.

Posted by Peter Donald <do...@apache.org>.
At 10:50  4/04/01 -0700, Steve Loughran wrote:
>Comments? Contributions to where the doc is incomplete?

Good except for code conventions - we should let people do it the way the
want unless it is in the core (and it is consitent).


Cheers,

Pete

*-----------------------------------------------------*
| "Faced with the choice between changing one's mind, |
| and proving that there is no need to do so - almost |
| everyone gets busy on the proof."                   |
|              - John Kenneth Galbraith               |
*-----------------------------------------------------*