Apache Directory Project - [Checklist] Current Code Submission Checlist Documents?

Author

[Checklist] Current Code Submission Checlist Documents?

Ole Ersoy

2007-01-29, 1:11 pm

Hey Guys,

I started putting together a code
submission checklist, and wanted to see whether
we have documents like this already?

Just want to make sure I incorporate anything
already existing.

Emmanuel I think you had a code standards document
somewhere. Ah...I found it by googleing for "apache
directory coding standards". Should be easier to find
though. I'll put a JIRA in for it when I submit the
coding checklist document for review.

Incidentally I did find this when googleing for
apacheds directory wiki:

http://wiki.apache.org/directory/IdeHome

This looks really good.

Cheers,
- Ole

________________________________________
________________________________________
____
Finding fabulous fares is fun.
Let Yahoo! FareChase search your favorite travel sites to find flight and hotel bargains.
http://farechase.yahoo.com/promo-generic-14795097

Emmanuel Lecharny

2007-01-29, 1:11 pm

On 1/29/07, Ole Ersoy <ole_ersoy-/E1597aS9LQAvxtiuMwx3w@public.gmane.org> wrote:
>
> Hey Guys,
>
> I started putting together a code
> submission checklist, and wanted to see whether
> we have documents like this already?

Hmmm... Depends on what you mean by "code submission checklist"

Just want to make sure I incorporate anything
> already existing.
>
> Emmanuel I think you had a code standards document
> somewhere. Ah...I found it by googleing for "apache
> directory coding standards".

http://cwiki.apache.org/confluence/...oding+standards

Should be easier to find
> though.

Yeah... We are trying to fix the site atm. Will take some time. In the
meantime, this is hopeless. Tanks google to be so performant !

I'll put a JIRA in for it when I submit the
> coding checklist document for review.
>
> Incidentally I did find this when googleing for
> apacheds directory wiki:
>
> http://wiki.apache.org/directory/IdeHome

Old shit I wrote once upon a time. It needs to be put in confluence and
seriously updated ...

This looks really good.
>
> Cheers,
> - Ole
>
>
>
>
>
> ________________________________________
________________________________________
____
> Finding fabulous fares is fun.
> Let Yahoo! FareChase search your favorite travel sites to find flight and
> hotel bargains.
> http://farechase.yahoo.com/promo-generic-14795097
>

--
Cordialement,
Emmanuel Lécharny
www.iktek.com

Ole Ersoy

2007-01-29, 7:11 pm

Oh,

By checklist I mean things that should be checked off
by committers that ensures that the submission
complies with Directory standards.

Like:

All public API methods are "Javadoced".

Test cases (I'm going to be writing a little paper on
this, and if you want to know more just google for
"junit 100% method testing ole ersoy", and you'll come
across the general idea on the JUnit mailing list.

This is necessary, because we need a definition of the
test requirements.

Use Case Documentation (Both developer and user).

etc.

Cheers,
- Ole

--- Emmanuel Lecharny <elecharny-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:

> On 1/29/07, Ole Ersoy <ole_ersoy-/E1597aS9LQAvxtiuMwx3w@public.gmane.org> wrote:
>
>
> Hmmm... Depends on what you mean by "code submission
> checklist"
>
> Just want to make sure I incorporate anything
> "apache
>
>
>
http://cwiki.apache.org/confluence/...oding+standards
>
> Should be easier to find
>
>
> Yeah... We are trying to fix the site atm. Will
> take some time. In the
> meantime, this is hopeless. Tanks google to be so
> performant !
>
> I'll put a JIRA in for it when I submit the
>
>
> Old shit I wrote once upon a time. It needs to be
> put in confluence and
> seriously updated ...
>
> This looks really good.
>
________________________________________
________________________________________
____
> sites to find flight and
>
>
>
> --
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com
>

________________________________________
________________________________________
____
The fish are biting.
Get more visitors on your site using Yahoo! Search Marketing.
http://searchmarketing.yahoo.com/ar...edsearch_v2.php

Ole Ersoy

2007-01-30, 1:11 am

<snip: confluence>
OK - I'll put a link to the apt generated html :-)

It opens directly from subversion anyways.

As soon as I find those extra 36 hours in the day, I'm
going to make an Eclipse plugin that is pulls xsd
template schemas from a (Maven like) repository and
automatically produces sample instance documents for
documenting in a standardized template format.

Then I need another mojo that produces corresponding
eclipse plugin documentation in a larger context.

Then we can keep documentation tied tightly to a
project, subversion it, and gain all the benefits I
put in the Eclipse Help System proposal.

<snip:testing>
The 100% method will be very straight forward once the
tooling is done. I'll hold off on discussing anymore,
because I want the paper to be the context for it.

The main thing I want comitters to understand is the
methodology. Doing the methodology by hand could be a
little tricky :-),

The other benefit is that there will be a clearly
defined unambiguous doable unit testing goal for the
project.

<snip: following in other's footsteps:>
Yeah - the unit testing lines to total code lines
ratio is slightly skewed right now :-)

So I would think of the checklist as reflecting the
goal and approach of where we want to be.

Personally I would also expect us to come together and
review and agree on a set of standards so that we all
do them.

That said the primary criteria should be for these to
make us more efficient, ofcoarse.

If you would like a hint besides the JUnit discussion
around the testing automation, check out:

www.agitar.com
www.junitfactory.com

These guys were also in the JUnit discssion btw :-)

Cheers,
- Ole

________________________________________
________________________________________
____
Have a burning question?
Go to www.Answers.yahoo.com and get answers from real people who know.