A few little tweaks to the contribution guide

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@953716 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/documentation/content/xdocs/getinvolved/index.xml b/src/documentation/content/xdocs/getinvolved/index.xml
index eeab7c6e7973e8c247daf284eb6f54e3b3ab19fb..1deb9397bb840d09a326db05aa8b278e1da7e523 100644 (file)
--- a/src/documentation/content/xdocs/getinvolved/index.xml
+++ b/src/documentation/content/xdocs/getinvolved/index.xml
@@ -119,17 +119,23 @@
      <li>Read the rest of the website, understand what POI is and what it does,
          the project vision, etc.</li>
      <li>Use POI a bit, look for gaps in the documentation and examples.</li>
-     <li>Join the mail lists and share your knowledge with others.</li>
+     <li>Join the <link href="../mailinglists.html">mailing lists</link> and share your knowledge with others.</li>
      <li>Get <link href="../subversion.html">Subversion</link> and check out the POI source tree</li>
      <li>Documentation is always the best place to start contributing, maybe you found that if the documentation just told you how to do X then it would make more sense, modify the documentation.</li>
+     <li>Contribute examples - if there's something people are often asking about on the <link href="../mailinglists.html">user list</link> which isn't covered in the documentation or current examples, try writing an example of this and uploading it as a patch.</li>
      <li>Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.</li>
      <li>Write Unit Tests.  Great way to understand POI.  Look for classes that aren't tested, or aren't tested on a public/protected method level, start there.</li>
      <li>Download the file format documentation from Microsoft -
       <link href="http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx">OLE2 Binary File Formats</link> or
       <link href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">OOXML XML File Formats</link></li>
      <li>Submit patches (see below) of your contributions, modifications.</li>
-     <li>Fill out new features, see <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</link> for suggestions.</li>
+     <li>Check the <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">bug database</link> for simple problem reports, and write a patch to fix the problem</li>
+     <li>Add in new features, see <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</link> for suggestions.</li>
    </ul>
+   <p>The Nutch project also have a very useful guide on becoming a 
+    new developer in their project. While it is written for their project,
+    a large part of it will apply to POI too. You can read it at
+    <link href="http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer">http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</link></p>
   </section>
   <section><title>Submitting Patches</title>
    <p>

diff --git a/src/documentation/content/xdocs/guidelines.xml b/src/documentation/content/xdocs/guidelines.xml
index 485d6db8fb1f84929f074fc41faaa12c9040e412..4b6e5aff7c705e50457669000414b9c2603b1f05 100644 (file)
--- a/src/documentation/content/xdocs/guidelines.xml
+++ b/src/documentation/content/xdocs/guidelines.xml
@@ -119,17 +119,23 @@
      <li>Read the rest of the website, understand what POI is and what it does,
          the project vision, etc.</li>
      <li>Use POI a bit, look for gaps in the documentation and examples.</li>
-     <li>Join the mail lists and share your knowledge with others.</li>
+     <li>Join the <link href="mailinglists.html">mailing lists</link> and share your knowledge with others.</li>
      <li>Get <link href="subversion.html">Subversion</link> and check out the POI source tree</li>
      <li>Documentation is always the best place to start contributing, maybe you found that if the documentation just told you how to do X then it would make more sense, modify the documentation.</li>
+     <li>Contribute examples - if there's something people are often asking about on the <link href="mailinglists.html">user list</link> which isn't covered in the documentation or current examples, try writing an example of this and uploading it as a patch.</li>
      <li>Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.</li>
      <li>Write Unit Tests.  Great way to understand POI.  Look for classes that aren't tested, or aren't tested on a public/protected method level, start there.</li>
      <li>Download the file format documentation from Microsoft -
       <link href="http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx">OLE2 Binary File Formats</link> or
       <link href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">OOXML XML File Formats</link></li>
      <li>Submit patches (see below) of your contributions, modifications.</li>
-     <li>Fill out new features, see <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</link> for suggestions.</li>
+     <li>Check the <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">bug database</link> for simple problem reports, and write a patch to fix the problem</li>
+     <li>Add in new features, see <link href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</link> for suggestions.</li>
    </ul>
+   <p>The Nutch project also have a very useful guide on becoming a 
+    new developer in their project. While it is written for their project,
+    a large part of it will apply to POI too. You can read it at
+    <link href="http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer">http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</link></p>
   </section>
   <section><title>Submitting Patches</title>
    <p>