About Sitellite       Screenshots       Downloads       Forge      Documentation       Community       Support

You are here: Home / Community / Contributions

Contributions

Sitellite CMS is an Open Source project.  As such, we welcome and encourage users of the software to also participate in improving it as well.  The following contains information meant to facilitate the process of contributing to the project.

Roadmap

If you're interested in contributing to the Sitellite CMS project, a good place to go for ideas is our Sitellite 5.0 Roadmap.  It will give you an idea of where we're going, and how we're going to get there, and how you can help.

Copyright Assignment

To enable SIMIAN systems to effectively provide license management, enforce legal compliance, and issue technology adequately to commercial licensees, all contributions being made for inclusion in the Sitellite CMS technology base must make a copyright assignment of the source code to SIMIAN systems Inc. This follows from the same principals as recommended by the Free Software Foundation regarding copyright assignment for contributions to the GNU Project. Copyright assignment is a common requirement within open source projects for legal indemnification management and for flexibility of second licensing.

Coding Standards

All contributors should try to conform to the Sitellite Coding Standards.  Submissions which do not conform to the standards may be returned with a request to address any such problems.

Documentation

Sitellite uses phpDocumentor to document all classes, functions, etc.  Contributions should include appropriate documentation.

Submission Format (Patches)

Every patch must have several pieces of information for us to properly evaluate it:

  • A description of the feature/problem/bug and how your patch addresses it
    For new features, a description of the feature and your implementation. For bugs, a description of what was wrong with the existing code, and a reference to any previous bug report (bug tracking coming soon).
  • Test cases
    Sitellite uses PHPUnit to test classes in the Sitellite Application Framework (SAF). If test cases are available for the functionality covered by your patch, all existing tests must pass. New functionality should also include PHPUnit tests, so that we can easily verify that the functionality works as advertised. Also, since the SAF unit tests are far from complete at present, we welcome any submissions of unit tests themselves.
  • The patch itself
    Patches should be made against the CVS repository, instead of patches against releases (unless your patch is intended as a candidate for a particular release branch). To make a patch against the CVS repository in your current working copy, use:
    cvs update -dP; cvs diff -c3u > your_changes.patch
    Please send patches for each bug fix/new feature individually, so that we may be able to apply the changes at different times (ie. if there is an issue with one of the changes). For information on accessing the Sitellite CVS repository, see the CVS info page.

Sending Submissions

You can make your submission(s) by sending an email to contributions@sitellite.org.

Members

Note: You can use your SitelliteForge.com account here and vice versa.

Username

Password

Forgot your password?

Not a member? Click here to register

Sitellite 5 Beta


Copyright © 2008, SIMIAN systems Inc.
All rights reserved. Privacy policy
Some of the icons on this site were created by the Gnome Project.