Contributing

Added by Daniel Murley, last edited by Kimie Nakahara on Jul 06, 2007  (view change)

Contributing to the Sandbox

Contributing to the sandbox is easy!

  • Go to Karora's JIRA (http://www.karora.org/JIRA/) and create an issue for a new feature in the sandbox.
  • Place a detailed description of the component, along with how to use it
  • Upload your component into JIRA (source code, resources, docs, etc) in a zip file.

The Karora team will move it to the sandbox repository as soon as they can. Although getting a component into sandbox is quite a simple process, some rules apply in order to ensure that only useful and maintainable components are being added. 

  • Code must compile
  • Components should be interesting for Cooee users. It means that Karora team or Cooee community should have interest on using your component. You can post in the forum asking people to vote for your issue on JIRA  - yes, do your job on advertisement!

If you want to see your component in sandbox quickly, then also follow some adittional rules to make it easier to Karora team review and approve your contribution:

Conform to the following package naming convention:

Package name Description
org.karora.cooee.sandbox.projectname.app Component code
org.karora.cooee.sandbox.projectname.webcontainer Rendering peers
org.karora.cooee.sandbox.projectname.webcontainer.resource.js Javascript
org.karora.cooee.sandbox.projectname.webcontainer.resource.image Images

Provide meaningful javadocs with your code.

Provide some kind of demonstration for your components.

An easy way to make a simple demo application is using Cooee Archetype#Cooee+Archetype, following the same structure of Sandbox Demo Application (source code available on Cooee SVN).

If you want to be a "top notch" contributor, update the wiki with documentation about your component also.

Although not compulsory, ideally your contribution should be a Maven2 project and conform to the default source structure.

Upgrading from Sandbox to core

From time to time, components will be considered to for an "upgrade" out of the sandbox and into the Cooee Core. This may be as an additional component, a merge with another component or perhaps even just a replacement. However, unlike sandbox contribution, the rules for moving a component into the core, are somewhat more strict:

1. A JIRA Request to move the component must be raised and approved

3. It must not interfere with the operation of other components
4. Code must be javadoc'ed
5. Documentation must be provided (More details soon)
6. There must be a demo for the component (in the form of the existing demos)
7. Junit test cases must be provided

Labels

 
(None)