|Version 1 (modified by leo_sauermann, 4 years ago)|
Have questions? Found bugs? Created a new implementation or improved an existing one? Want to know about future plans?
The first place to ask around is the Aperture developers mailing list:
Currently, there is no separate users mailing list but you're welcome to ask Aperture usage questions on the developers mailing list for now. There is also the Aperture Forum if you don't want to subscribe to a mailing list.
Just checkout the source code, from
Read the README.txt file for detailed build instructions,
do your changes, create appropriate unit tests, make sure they pass and submit a patch. There are still some things you would need to be aware of. They have been gathered on separate pages: [DevelopersChecklists] and [ReleaseChecklist]. Please skim through them.
Aperture has a comprehensive JUnit test suite. Some components cannot be tested with JUnit tests though. These include OS-specific components (Outlook Crawler, Apple Addressbook crawler etc.) and components that interact with remote hosts (WebCrawler or IMAPCrawler). It is vital that these components be tested extensively. That's why anyone willing to contribute his/her time to the development of Aperture is invited to download the latest Aperture code and play with the example apps. (Especially the command-line apps with the --validate switch). For details see [ApertureExampleApplications].
Things you can do today
We are constantly trying to improve and expand our set of supported data sources and file formats. If you have created an Extractor or Crawler implementation that would be interesting for us to include or have created an improvement of an existing implementation, please contact us on this mailing list.
In order of urgence (first things first) we search for people who:
- Fix bugs listed on the tracker
- Implement new features listed on the tracker
- Improve this wiki by correcting typos and extending existing texts
- Contribute your existing extractors and crawlers
- Write new extractors and crawlers
- Improve the architecture of aperture and contribute to the discussion of open issues: most pressing is support to manipulate data inside the data sources (update, add, delete), and to listen to changes in the data sources (listening instead of crawling as a performance optimization). Suggest an improvement!
- Join the project, and later, become a project administrator
When you find and fix a bug, or implement an enhancement, you can give the code back to the project.
We accept clean patches, they must be easy to test and integrate:
- Checkout latest from SVN
- Make your changes
- Bonus points: make a JUnit test that verifies your changes or adapt an existing JUnit test
- Create a patch that contains all changes
- Use Sourceforge's bug tracker for aperture and attacht the patch as file to it (and then send an e-mail to the aperture-devel list to have your patch reviewed)
- Tickets must be marked "pending" when a patch is to be reviewed
- Patches must be reviewed and accepted or rejected within 14 days or they will be automatically closed by the tracker'''
- After reviewing the patch: if it is accepted, either the reviewer or the submitter of the patch commit it to trunk
- Bonus points: update the wiki when your patch implies a change of documentation
Patch reviewers are: Chris Fluit, Antoni Mylka, Leo Sauermann.
We need more patch reviewers!!!
The legal policies concerning contributions to Aperture are as follows:
- For each file, the author(s) retain the copyright to the file and are named in the header. The two main authors are "Aduna" and "Deutsches Forschungszentrum fuer Kuenstliche Intelligenz DFKI GmbH."
- For each file, the years in the copyright notice start at the first commit and end at the last change. The second year means the year ofthe last change and is edited by hand when editing the file.
- The sources are licensed with a BSD-like license.
- The existing copyright headers are not to be changed. New files are copyright by the creating party, if shared (such as employees of multiple companies), both parties are listed.
- All legal parties who contribute must sign Aduna's Contributor License Agreement (CLA). Contact Hilde Bleeker (hilde DOT bleeker AT_SIGN aduna-software DOT com) for details.
Example copyright notice:
/* * Copyright (c) 2005 - 2008 Aduna and Deutsches Forschungszentrum fuer Kuenstliche Intelligenz DFKI GmbH. * All rights reserved. * * Licensed under the Aperture BSD-style license. */