How To... Start a Project - Project Descriptors

The file status.xml describes the current status of your project. Details include:

• developer list
• todo list
• changelog

This file should be customised for each project. The Krysalis-Project template has the status.xml file below. This file is stored in the root directory of your project and is used in some of the documentation generation antlibs. For example, when building a distribution changes and todo text files are created for inclusion in your distribution files.

<?xml version="1.0"?>
<status>

  <developers>
    <!-- in strict id alphabetical order -->
    <person name="Andrew C. Oliver"   id="acoliver"  email="acoliver@apache.org"/>
    <person name="Nick Chalko"        id="chalko"  email="chalko@users.sourceforge.net"/>
    <person name="Glen Stampoultzis"  id="glens"     email="glens@apache.org"/>
    <person name="Marc Johnson"       id="mjohnson"  email="mjohnson@apache.org"/>
    <person name="Nicola Ken Barozzi" id="nicolaken" email="nicolaken@apache.org"/>
    <person name="Ross D. Gardler"    id="rgardler"   email="ross@saafe.org"/>
    <person name="Rainer Klute"       id="rainer"    email="rainer@apache.org"/>
  </developers>
  
  <todo>
   <actions priority="high">
    <action context="code" assigned-to="all">
      Test, test, test :-)
    </action>   
   </actions>   
  </todo>

  <changes>
   <release version="0.1" date="20020511">
    <description>This template is what the Krysalis team recomend as a minimum
    structure for Krysalis Community projects.</description>
    <action dev="rdg" type="add">
      Created Krysalis-Project template
    </action>             
   </release>
  </changes>  

</status>

	developers

The developers list is, obviously, a list of developers who have worked on your project.

	todo

The todo element contains information about things that are still left to do on the project.

	changes

The changes element is where you should record all changes between versions. The element can have any number of child release elements, each relating to a specific release of the project.