Skip to content

Latest commit

 

History

History
140 lines (107 loc) · 7.2 KB

CONTRIBUTING.md

File metadata and controls

140 lines (107 loc) · 7.2 KB
Raw

Contributing to CLDR

Overview

The CLDR project consists of 3 aspects:

  1. Data: We rely on contributions by native language speakers that are most commonly used currently in the given country/region. Most data is collected through the Survey Tool. See How to contribute.
    • If you are not a native language speaker, but have evidence of CLDR data being incorrect, file a Jira ticket to report the issue.
    • For data that is not collected in the Survey Tool, such as supplemental data, file a Jira ticket and provide evidence for changing the data.
  2. Internationalization structure: Requires a ticket to be changed.
    • For structural issues, note that many issues may be due to misunderstandings of the LDML spec. For example, <pattern>¤#,##0.00</pattern> has a specialized format where each character represents a special function.
    • File a Jira ticket and provide evidence for the spec issues or to establish a new structure.
    • If your organization is not a Unicode member, consider becoming a member and working as a CLDR technical committee member.
  3. CLDR internal tooling such as adding new tests or fixing tooling that enable CLDR builds and releases. See CLDR Developer introduction.

Areas where contributions are welcome

  • cldr-apps/: (Survey Tool). Improvements here include:
    • UI: performance improvements, visual and functional refinements
    • Additional checks (CheckCLDR) to validate CLDR data.
  • java/: The core CLDR tooling. Improvements could include:
    • better documentation around code components
    • updates to use newer/different library dependencies
    • writing unit tests to improve code coverage
    • better documentation around command line tools

Requirements for merged PRs

For all PRs these steps are required before the PR is merged:

  • The PR and commits must reference a Jira ticket which has been accepted by the CLDR-TC. Open a ticket if there is not already a relevant one open.
  • A Contributor License Agreement (CLA) must be signed. For more information, see Contributor License Agreement, below.
  • All tests must pass (See below)
  • The PR must be reviewed by a TC member.
  • The PR should have a single commit, and the first line of the commit must begin with the accepted Jira ticket number.

Sample commit message

CLDR-0000 Brief Description of Change

Optionally, this is the first line of an extended description,
after the blank line.
- Here is an item
- Here is another item

Contributor License Agreement

In order to contribute to this project, the Unicode Consortium must have on file a Contributor License Agreement (CLA) covering your contributions, either an individual or a corporate CLA. Pull Requests, issues, and other contributions will not be merged/accepted until the correct CLA is signed. Which version needs to be signed depends on who owns the contribution being made: you as the individual making the contribution or your employer. It is your responsibility to determine whether your contribution is owned by your employer. Please review the Unicode Intellectual Property, Licensing, & Technical Contribution Policy for further guidance on which CLA to sign, as well as other information and guidelines regarding the Consortium’s licensing and technical contribution policies and procedures.

To sign the CLA in Github, open a Pull Request (a comment will be automatically added with a link to the CLA Form), or go directly to the CLA Form. You may need to sign in to Github to see the entire CLA Form.

  • Individual CLA: If you have determined that the Individual CLA is appropriate, then when you access the CLA Form, click the Individual CLA and complete the Form.

  • Corporate CLA: If you have determined that a Corporate CLA is appropriate, please first check the public list of Corporate CLAs that the Consortium has on file. If your employer is listed, then when you access the CLA Form, you can click the box indicating that you are covered by your employer’s corporate CLA. If your employer is not on the list, then it has not already signed a CLA and you will need to arrange for your employer to do so before you contribute, as described in How to Sign a Unicode CLA.

Unless otherwise noted in the LICENSE file, this project is released under the OSI-approved free and open-source Unicode License v3.

Building

For setup details, see Maven Setup. Builds are done with Maven:

mvn test --file=tools/pom.xml

Tests

For more detail, and how to run the tests locally, see Running Tests on the CLDR development site.

Automatic Test Runs

Tests are automatically run once a commit is pushed to GitHub and when a PR is opened requesting changes to CLDR. You will see the status check next to each commit's hash, it will show as a circle, x, or checkmark. (●✖✔). For GitHub documentation, see About Status Checks. You can click on these indicators anywhere they appear for more details.

Briefly:

  • ● An orange circle indicates that information is not available yet, such as a test that is still running or has not started yet.
  • ✖ A red X indicates a failure or a warning. Depending on the type of issue, merging might be blocked.
  • ✔ A green checkmark indicates success.

Commit Checks

Similarly, in a PR, certain checks are marked as “Required.” All required checks must succeed before merging is allowed.

PR Checks

If a test or status check does not pass, see Running Tests on the CLDR development site.

Copyright

Copyright © 1991-2024 Unicode, Inc. All rights reserved. Terms of use