conventions.txt

$Id$

XP framework ivy build conventions
===================================

These guidelines are inspired by the maven project layout conventions.

Maven Standard Directory Layout:
http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html




Directory layout
----------------

A standard project should follow these guidelines for directory
layout:

project
 `- build.xml
 `- ivy.xml
 `- unittest.ini
 `- src/
    `- main/
       `- <language>
          `- namespaces & classes
       `- <type> (optional)
          `- files
    `- test/
       `- <language>
          `- namespaces & classes
    `- site/
       `- web resources

Where:
* <language> is the language name, in a wider sense, eg.:
  php, java, c, cpp, xsl, pl, ...
  
* <type> is a more general type of file collection, eg.:
  resources, config, webapp, ...