Development‎ > ‎

Contributions to the ICU library

Overview

This section provides the guidelines for contributing code to the ICU library. Contribution is added functionality to ICU. Bug fixes can always be submitted to the jitterbug database.

Why Contribute?

ICU is an open source library that is a de-facto industry standard for internationalization libraries. Our goal is to provide top of the line i18n support on all widely used platforms. By contributing your code to the ICU library, you will get the benefit of continuing improvement by the ICU team and the community, as well as testing and multi-platform portability. In addition, it saves you from having to re-merge your own additions into ICU each time you upgrade to a new ICU release.

General Contribution Requirements

We will be glad to take a look at the code you wish to contribute to ICU. We cannot guarantee that the code will be included. Contributions of general interest and written according to the following guidelines have a better chance of becoming a part of ICU.

For any significant new functionality, contact the ICU development team through the icu-design mailing list first, and discuss the features, design and scope of the possible contribution. This helps ensure that the contribution is expected and will be welcome, that it will fit in well with the rest of ICU, and that it does not overlap with other development work that may be underway.

While you are considering contributing code to ICU, make sure that the legal terms (see Legal Issues (§) below) are acceptable to you and your organization.

Here are several things to keep in mind when developing a potential contribution to the ICU project:

  1. ICU has both C/C++ and Java versions. If you develop in one programming language, please either provide a port or make sure that the logic is clear enough so that the code can be reasonably ported. We cannot guarantee that we will port a contribution to the other library.

    NoteICU4J is (now) trying to limit itself to using Java 1.3 APIs. Java 1.4 APIs might be considered for some tools. Java 5 and later APIs are not permitted.
  2. Before implementation, read and understand ICU's coding guidelines . Contributions that require too much adaptation to be included in the ICU tree will probably wait for a long time.

  3. During implementation, try to mimic the style already present in the ICU source code.

  4. Always develop the code as an integral part of the library, rather than an add-on.

  5. Always provide enough test code and test cases. We require that our APIs are 100% tested and that tests cover at least 85% of the ICU library code. Make sure that your tests are integrated into one of ICU's test suites (cintltst and intltest for ICU4C and com.ibm.icu.dev.test classes in ICU4J). New tests and the complete test suite should pass.

  6. Compile using the strictest compiler options. Due to ICU's multi-platform nature, warnings on some platforms may mean disastrous errors on other platforms. This can be enabled by using the --enable-strict configure option on any platform using the gcc compiler.

  7. Test on more than one platform. For ICU4C, it is good to combine testing on Windows with testing on Linux, Mac OS X or another Unix platform. It is always good to try to mix big and little endian platforms. For ICU4J, test using both Sun's and IBM's JDKs.

  8. Each contribution should contain everything that will allow building, testing and running ICU with the contribution. This usually includes: source code, build files and test files.

Legal Issues

In order for your code to be contributed, you need to assign to IBM joint copyright ownership in the contribution. You retain joint ownership in the contribution without restriction. (For the complete set of terms, please see the forms mentioned below.)

The sections below describe two processes, for one-time and ongoing contributors. In either case, please complete the form(s) electronically and send it/them to IBM for review. After review by IBM, please print and sign the form(s), send it/them by mail, and send the code. The code will then be evaluated.

Please consult a legal representative if you do not understand the implications of the copyright assignment.

One-Time Contributors

If you would like to make a contribution only once or infrequently, please use the Joint Copyright Assignment - One-time Contribution form. (http://source.icu-project.org/repos/icu/icuhtml/trunkl/legal/contributions/Copyright_Assignment.rtf ). The contribution will be identified by a bug ID which is unique to the contribution and entered into the form. Therefore, please make sure that there is an appropriate bug (or Request For Enhancement) in the ICU bug database, or submit one.

The code contribution will be checked into a special part of the ICU source code repository and evaluated. The ICU team may request updates, for example for better conformance with the ICU design principles, coding and testing guidelines, or performance. (See also the Requirements (§) above.) Such updates can be contributed without exchanging another form: An ICU team member commits related materials into the ICU source code repository using the same bug ID that was entered into the copyright assignment form.

Ongoing Contributors

If you are interested in making frequent contributions to ICU, then the ICU Project Management Committee may agree to invite you as an ongoing contributor. Ongoing contributors may be individuals but are more typically expected to be companies with one or more people (“authors”) writing different parts of one or more contributions.

In this case, the relationship between the contributor and the ICU team is much closer: One or more authors belonging to the contributor will have commit access to the ICU source code repository. With this direct access come additional responsibilities including an understanding that the contributor will work to follow the technical Requirements (§) above for contributions, and agreement to adhere to the terms of the copyright assignment forms for all future contributions.

The process for ongoing contributors involves two types of forms: Initially, and only once, an ongoing contributor submits a Joint Copyright Assignment by Ongoing Contributor form, agreeing to essentially the same terms as in the one-time contributor form, for all future contributions. (See the form at http://source.icu-project.org/repos/icu/icuhtml/trunk/legal/contributions/Copyright_Assignment_ongoing.rtf )

The contributor must also send another form, Addendum to Joint Copyright Assignment by Ongoing Contributor: Authors, for the initial set and each addition of authors to ICU contributions, before any contributions from these authors are committed into the ICU source code repository. (Only new, additional authors need to be listed on each such form.) The contributor agrees to ensure that all of these authors agree to adhere to the terms of the associated Joint Copyright Assignment by Ongoing Contributor Agreement. (See the Authors Addendum form at http://source.icu-project.org/repos/icu/icuhtml/trunk/legal/contributions/Copyright_Assignment_authors.rtf )

Some of an ongoing contributor's authors will have commit access to the ICU source code repository. Their committer IDs need to be established before completing the Authors Addendum form, so that these committer IDs can be entered there. (The committer IDs should be activated only after the form is received.)

Committer authors commit materials directly into the appropriate parts of the ICU source code repository. Contributions from an ongoing contributor are identified by their association with the contributor's committer IDs.

Previous Contributions

All previous "one-off" contributions from non-IBM sources to ICU are listed on the code contributions page in ICU's source code repository. The page contains links to the softcopies of the Joint Copyright Assignment forms. See http://source.icu-project.org/repos/icu/icuhtml/trunk/legal/contributions/code_contributions.html

In addition, the following non-IBM companies are registered as Ongoing Contributors:

  • Apple
  • Google

See the repository folder that contains the contributions page for the full set of softcopies of contributor agreements including one-off contributions, ongoing-contributor agreements and author-addendum documents to ongoing-contributor agreements: http://source.icu-project.org/repos/icu/icuhtml/trunk/legal/contributions/

Comments