db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "DerbyContributorChecklist" by JohnHEmbretsen
Date Fri, 03 Mar 2006 13:52:34 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The following page has been changed by JohnHEmbretsen:
http://wiki.apache.org/db-derby/DerbyContributorChecklist

The comment on the change is:
Making some changes, as mentioned on derby-user 2006-02-24

------------------------------------------------------------------------------
- This page collects a checklist for engineers contributing code to Derby.
+ This page collects a checklist for people contributing code or documentation to Derby.
  
  ||'''Item'''||'''Description'''||
  ||ASL||When attaching a patch to a JIRA issue, be sure to mark the checkbox that cedes license
rights to Apache.||
  ||ICLA||If you are attaching a large patch, you should sign an [http://www.apache.org/licenses/icla.pdf
 ICLA], generally granting Apache license rights over your Derby contributions. Evidence that
you filed an ICLA is supposed to appear in the [http://people.apache.org/~jim/committers.html
 Contributors list]. However, since Apache updates this list only sporadically, you may need
to resubmit your ICLA or pester Apache to notice it. For more information, see the [http://www.apache.org/licenses/
 Apache licensing info].||
- ||Copyright Notice||Every java file in your patch must start with the Apache [http://www.apache.org/licenses/LICENSE-2.0.html#apply
 copyright notice]. See the existing Derby Java files for examples. ||
+ ||Copyright Notice||Every java and [http://db.apache.org/derby/manuals/dita.html DITA source]
file in your patch must start with the Apache [http://www.apache.org/licenses/LICENSE-2.0.html#apply
 copyright notice]. You should update the year(s) in the copyright notice as appropriate:
The year should be the year the file was first created, as well as additional years when the
file was revised or updated, utilizing either a series of years separated by commas (yyyy,
yyyy, yyyy) or the first year and current year separated by a dash (yyyy-yyyy). See the existing
Derby Java files for examples. ||
- ||Tests||Don't forget to include regression tests with your patch.||
+ ||Tests||Don't forget to include regression tests with your code patch.||
- ||Coding Standards||The Derby community has not approved a common body of coding standards.
Individual contributors have found the following standards useful: [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
 Java Coding Standards] and [http://wiki.apache.org/geronimo/CodingStandards  Geronimo Coding
Standards].||
+ ||Coding Standards||The Derby community has not approved a common body of coding standards.
Individual contributors have found the following standards useful: [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
 Java Coding Standards] and [http://wiki.apache.org/geronimo/CodingStandards  Geronimo Coding
Standards]. For example, not including @author tags and limiting line lengths to 80 characters
is encouraged by several Derby committers.||
- ||Comments||Make sure you comment your code.||
+ ||Comments||Make sure you comment your code. Pay special attention to @param and @return
tags in method Javadocs. [http://java.sun.com/j2se/javadoc/writingdoccomments/ How to Write
Doc Comments for the Javadoc Tool] may be a good source of reference if you are not sure how
to write Javadoc.||
  ||Tabs||Set your tabs at 4 spaces. This was the original Cloudscape convention. With this
setting your code should look readable.||
  

Mime
View raw message