= Welcome the Editam development site =

Editam is a content management platform based in these core principles and objectives

 * Simplicity
 * Usability
 * Standard awareness
 * Efficiency
 * Openness
 * Internationalization
 * Extendability
 * Compatibility

These core principles are key for most Content writers, Graphic designers, Web developers, SEO, interaction design experts and web developers, but rarely are found on Open Source CMS were the focus is at adding as more features as possible.

Editam is available open-source under the [http://svn.editam.com/trunk/src/LICENSE.txt GPL3 license].

Released on September the 18th, and it stills in its infancy, so '''PLEASE DON'T USE EDITAM''' in production environments. At it's current stage Editam is only intended to be used by experienced developers.

== Getting involved ==

This site is the meeting point for contributors who want to contribute to the Editam community.

Everybody can participate by:

 - [http://trac.editam.com/newticket Reporting bugs] 
 - [http://trac.editam.com/wiki/EditamDocumentation Adding/Improving Documentation]
 - Submitting plugins 
 - Submitting patches

== Feature request policy ==

If you'd love to see that must-have/can-live-without feature in Editam we can't promise we can implement it. We highly value simplicity and we don't want Editam to become a feature bloated system. 

We will work hard with plugin developers and will do our best to maintain a high quality plugin repository so you can add functionality to Editam as needed.

== Checking out the source ==

The Subversion repository resides at http://svn.editam.com/

Check out the current development trunk with:

  '''{{{svn co http://svn.editam.com/trunk editam}}}'''


== Building Editam ==

After checking out the trunk change to the '''build''' directory and run

   '''{{{php ./makelos.php}}}'''

It will generate a tar.gz and a .zip package at '''build/builds''' containing an Editam release.

== Creating a patch ==

Tickets are fine, but patches are great. If you want to modify Editam or fix a bug you've run across, there's no faster way to make it happen than to do it yourself. Editam thrives on the generous work of contributors from around the world. Please become one of them.

  1. '''Get Editam ready for patching'''
    1. Check out the latest source: `svn co http://svn.editam.com/trunk`
    1. Ensure that the existing unit tests pass.
  1. '''Make a test-driven change'''
    1. Add or change unit tests to prove that your change works.
    1. Make the change to the source.
    1. Verify that all tests pass by running '''`php ./include/tests/unit.php`'''. 
  1. '''Share your well-tested change'''
    1. Sanity check the changes you've made: `svn status`
    1. Create a patch: `svn diff > my_descriptively_named_patch.diff`
    1. [/login Login] to Trac or [/register register] a new user.
    1. [/newticket Create a new ticket] with [PATCH] as the first word in the summary. Attach your patch file.
    1. Keep an eye on the ticket and address concerns that arise. Make your change hard '''not''' to commit.
    1. Expect your ticket to be closed with an untested, undocumented, or incomplete resolution if it's missing tests, documentation, or implementation. Don't panic; the ticket hasn't been killed! These resolutions are the pathway to commit. Update your patch and reopen the ticket.
  1. '''Bask in the glory of being an Editam contributor! '''

== Source style ==

  * Edit source code files using UTF-8.
  * Four spaces, no tabs.
  * Don't use '''`and`''' and '''`or`''' for boolean tests, instead always use '''`&&`''' and '''`||`'''
  * `MyClass->myMethod($my_arg)` -- not `my_method( $my_arg )` or `MyMethod($myArg)`
  * Follow the conventions you see used in the source already
  * Have a look at [http://akelos.org/Akelos_Framework_Developer_Coding_Style_Guide.pdf Akelos Framework coding guidelines] before writing new functionality for Editam


== Editam mailing list ==

You can also subscribe to [http://groups.google.com/group/editam Editam mailing list hosted by Google]