Source Code

From AlfrescoWiki

Jump to: navigation, search


[edit] Contributing Alfresco Platform Fixes and Enhancements

This page provides information on how to gain access to Alfresco's source code for developing and contributing Alfresco platform fixes and enhancements.

Alternatively, you may want develop a whole new capability upon the Alfresco platform, in which case, you might want to start an Alfresco Forge project.

[edit] Checking out the source

The Alfresco Subversion repository resides at svn://www.alfresco.org/alfresco, so to check out the latest HEAD revision use the following command line:

svn co svn://svn.alfresco.com/alfresco/HEAD

You can also use the alternative HTTP URL http://svn.alfresco.com/repos/alfresco-open-mirror/alfresco/HEAD/

In case of error like : Error * PROPFIND request failed on '/repos/alfresco-open-mirror/alfresco/HEAD' PROPFIND of '/repos/alfresco-open-mirror/alfresco/HEAD': 500 Server Error (http://svn.alfresco.com) you can use this alternate url instead https://svn.alfresco.com/repos/alfresco-open-mirror/alfresco/HEAD/

[edit] Contributing a fix or enhancement

You're welcome to raise issues and enhancement requests in our JIRA issue tracking system. However, if you want to change any aspect of Alfresco or fix an issue you've hit, there's no more efficient way than to do it yourself. Alfresco's maturity comes from the contributions of its community, so, become part of that community and contribute today.

[edit] 1. Get Alfresco ready for patching

  1. Check out the HEAD revision using: svn co http://svn.alfresco.com/repos/alfresco-open-mirror/alfresco/HEAD/.
  2. Setup your development environment to enable the execution of unit tests.

[edit] 2. Make your change

  1. Update the source code to implement the fix or enhancement.
  2. Add or change any unit tests to prove the change worked.
  3. Verify that all (existing and new) tests work.

[edit] 3. Share your contribution

  1. Create a patch of your changes: svn diff > appropriately_named_patch.diff
  2. Create a new JIRA ticket of type Contribution and upload your diff.
  3. Keep track of your ticket in case discussion is required before the contribution is submitted to SVN.
  4. Now, let everyone know you're an Alfresco Contributor (Alfresco Forums).

[edit] Signing a Contribution Agreement

If you make contributions, and we accept them into our source tree, we want to make sure we have the flexibility to use those contributions under our free software licensing terms, other terms we may use in the future, or commercial terms. Of course, nothing will prevent you from making your contributions available under any open source licensing terms you choose. We simply ask that you allow us this flexibility, so our intellectual property position does not become too complicated. As a company, we have made a decision to make our intellectual property available to the community, so we want to make sure our resources are devoted to making our products the best they can be, rather than fighting legal battles over contributions. Therefore, if you wish to contribute code, we ask that you do so under our standard contribution agreement, which gives us this flexibility.

[edit] Spotlight Platform Contributions

  • Meta Data Extraction Framework and PDF/Open Office Format meta data extraction - Jesper Steen Moller
  • Open Document Format meta data extraction - Antti Jokipii
Retrieved from "http://wiki.alfresco.com/wiki/Source_Code"