You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "David W. Van Couvering" <Da...@Sun.COM> on 2005/10/15 18:48:07 UTC

[Fwd: Re: [Db-derby Wiki] Update of "SharedComponentVersioningGuidelines" by DavidVanCouvering]

Here's the email I thought I had sent to the whole list...

David

Re: [Db-derby Wiki] Update of "SharedComponentVersioningGuidelines" by DavidVanCouvering]

Posted by "David W. Van Couvering" <Da...@Sun.COM>.
That sounds good, thanks for the suggestion.

David

Daniel John Debrunner wrote:
> In the "Documenting Shared Components" in
> http://wiki.apache.org/db-derby/SharedComponentVersioningGuidelines
> there is this section:
> 
> <quote>
> We will provide a top-level README file under
> java/org/apache/derby/common that describes the shared components
> guidelines (once they are approved) and lists the available components.
> </quote>
> 
> I would suggest a minor change to not have a README file, but instead
> use package.html which will then tie into the javadoc (or more generally
> ensure it is documented so that it appears as part of the javadoc).
> 
> Dan.
>

Re: [Db-derby Wiki] Update of "SharedComponentVersioningGuidelines" by DavidVanCouvering]

Posted by Daniel John Debrunner <dj...@debrunners.com>.
In the "Documenting Shared Components" in
http://wiki.apache.org/db-derby/SharedComponentVersioningGuidelines
there is this section:

<quote>
We will provide a top-level README file under
java/org/apache/derby/common that describes the shared components
guidelines (once they are approved) and lists the available components.
</quote>

I would suggest a minor change to not have a README file, but instead
use package.html which will then tie into the javadoc (or more generally
ensure it is documented so that it appears as part of the javadoc).

Dan.

Re: [Db-derby Wiki] Update of "SharedComponentVersioningGuidelines" by DavidVanCouvering]

Posted by "David W. Van Couvering" <Da...@Sun.COM>.
OK, that's easy to change.

David

TomohitoNakayama wrote:
> Hello.
> 
> I think what I'm concerning now is problem of expression ...
> // Well ... , expression maybe everything in communication :-) .
> 
> I think expression of  "Adding new classes or methods to an existing 
> shared package does not need to be put up for a vote." may lead reader 
> to underestimate risks .
> 
> I think  "Adding new classes or methods to an existing shared package 
> needs just to be reviewed as usual code modification." would be better.
> 
> Best regards.
> 
> /*
> 
>         Tomohito Nakayama
>         tomonaka@basil.ocn.ne.jp
>         tomohito@rose.zero.ad.jp
>         tmnk@apache.org
> 
>         Naka
>         http://www5.ocn.ne.jp/~tomohito/TopPage.html
> 
> */

Re: Re: [Db-derby Wiki] Update of "SharedComponentVersioningGuidelines" by DavidVanCouvering]

Posted by TomohitoNakayama <to...@basil.ocn.ne.jp>.
Hello.

I think what I'm concerning now is problem of expression ...
// Well ... , expression maybe everything in communication :-) .

I think expression of 
  "Adding new classes or methods to an existing shared package does not need to be put up for a vote." 
may lead reader to underestimate risks .

I think 
  "Adding new classes or methods to an existing shared package needs just to be reviewed as usual code modification." 
would be better.

Best regards.

/*

         Tomohito Nakayama
         tomonaka@basil.ocn.ne.jp
         tomohito@rose.zero.ad.jp
         tmnk@apache.org

         Naka
         http://www5.ocn.ne.jp/~tomohito/TopPage.html

*/