From 8c602455fbf9c72e529b03ad8d9a483edd4f2353 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Fri, 11 Jun 2010 15:12:19 +0000 Subject: [PATCH] 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 --- src/documentation/content/xdocs/getinvolved/index.xml | 10 ++++++++-- src/documentation/content/xdocs/guidelines.xml | 10 ++++++++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/src/documentation/content/xdocs/getinvolved/index.xml b/src/documentation/content/xdocs/getinvolved/index.xml index eeab7c6e79..1deb9397bb 100644 --- a/src/documentation/content/xdocs/getinvolved/index.xml +++ b/src/documentation/content/xdocs/getinvolved/index.xml @@ -119,17 +119,23 @@
  • Read the rest of the website, understand what POI is and what it does, the project vision, etc.
  • Use POI a bit, look for gaps in the documentation and examples.
    • -
  • Join the mail lists and share your knowledge with others.
    • +
  • Join the mailing lists and share your knowledge with others.
  • Get Subversion and check out the POI source tree
  • 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.
    • +
  • Contribute examples - if there's something people are often asking about on the user list which isn't covered in the documentation or current examples, try writing an example of this and uploading it as a patch.
  • Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.
  • 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.
  • Download the file format documentation from Microsoft - OLE2 Binary File Formats or OOXML XML File Formats
  • Submit patches (see below) of your contributions, modifications.
    • -
  • Fill out new features, see Bug database for suggestions.
    • +
  • Check the bug database for simple problem reports, and write a patch to fix the problem
    • +
  • Add in new features, see Bug database for suggestions.
    • +

    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 + http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer

    Submitting Patches

    diff --git a/src/documentation/content/xdocs/guidelines.xml b/src/documentation/content/xdocs/guidelines.xml index 485d6db8fb..4b6e5aff7c 100644 --- a/src/documentation/content/xdocs/guidelines.xml +++ b/src/documentation/content/xdocs/guidelines.xml @@ -119,17 +119,23 @@

  • Read the rest of the website, understand what POI is and what it does, the project vision, etc.
  • Use POI a bit, look for gaps in the documentation and examples.
    • -
  • Join the mail lists and share your knowledge with others.
    • +
  • Join the mailing lists and share your knowledge with others.
  • Get Subversion and check out the POI source tree
  • 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.
    • +
  • Contribute examples - if there's something people are often asking about on the user list which isn't covered in the documentation or current examples, try writing an example of this and uploading it as a patch.
  • Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.
  • 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.
  • Download the file format documentation from Microsoft - OLE2 Binary File Formats or OOXML XML File Formats
  • Submit patches (see below) of your contributions, modifications.
    • -
  • Fill out new features, see Bug database for suggestions.
    • +
  • Check the bug database for simple problem reports, and write a patch to fix the problem
    • +
  • Add in new features, see Bug database for suggestions.
    • +

    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 + http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer

    Submitting Patches

    -- 2.39.5