Submitting Contributions

Document created by resplin Employee on Jun 19, 2015Last modified by resplin Employee on Jul 5, 2017
Version 6Show Document
  • View in full screen mode

Contributing a fix or enhancement

Alfresco's maturity comes from the contributions of its community. Contributing back to Alfresco can be a bit confusing as Alfresco is a collection of separate open source projects. Each open source project officially sponsored by Alfresco has a page in this space detailing its governance policy and the method for reporting issues and submitting contributions. See the tag for "project page".

 

This page explains the process for the ECM Repository that makes up Alfresco Community Edition.

 

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.

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.

If possible, try to follow the Alfresco Coding Standards in your change, to minimise the changes needed if the patch is accepted.

 

3. Share your contribution

Our team checks our JIRA issue tracking system for submitted patches, and merges them into the code base. Your patch is more likely to be accepted if you follow the Contribution Guidelines. When you submit an issue, you will be asked to accept to the Alfresco Contribution Agreement.

 

  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. Mark the 'patch attached' field on your issue.
  4. Keep track of your ticket in case discussion is required before the contribution is submitted to SVN.
  5. Now, let everyone know you're an Alfresco Contributor (Alfresco Forums).

If your patch gets accepted, make sure to list your contribution on the Featured Contributions page.

1 person found this helpful

Attachments

    Outcomes