Skip to content

Update README.md, contributing.md #6627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged

Update README.md, contributing.md #6627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to ICU4X Project
# Contributing to ICU4X

`ICU4X` is an open source project and welcomes everyone to participate.
ICU4X is an open source project and welcomes everyone to participate.

The core team has identified good starter projects and gave them **[good first issue](https://github.com/unicode-org/icu4x/issues?q=is%3Aissue+no%3Aassignee+label%3A%22good+first+issue%22+-label%3A%22blocked%22+) label**. This is a great place to start as a volunteer.

Expand Down Expand Up @@ -42,7 +42,7 @@ To build all code paths, improve build times in VSCode, and prevent locking the
}
```

Note: the path in `ICU4X_DATA_DIR` is relative to `provider/data/*/src/lib.rs` and it causes VSCode to build ICU4X with only the `und` locale. This reduces build times but also makes some tests fail; to run them normally, run `cargo test --all-features` on the command line.
Note: the path in `ICU4X_DATA_DIR` is relative to `provider/data/*/src/lib.rs` and it causes Rust Analyzer to build ICU4X with only the `und` locale. This reduces build times but also makes some tests fail; to run them normally, run `cargo test --all-features` on the command line.

### Building and Rebuilding Repo Data

Expand Down Expand Up @@ -81,6 +81,10 @@ Tips:
- To overwrite the directly, add: `-W`
- To print verbose logs, add: `-v`

### Browsing artifacts

Several artifacts that are generated from the `main` branch are viewable at <https://unicode-org.github.io/icu4x/>. These include API docs, benchmarks, and the WASM demo. It's useful to bookmark this page for quick access.

## Contributing a Pull Request

The first step is to fork the repository to your namespace and create a branch off of the `main` branch to work with.
Expand Down Expand Up @@ -120,7 +124,7 @@ need to run in order to recreate them. These files may be run in more comprehen
- `cargo make bakeddata` - regenerates baked data in the `provider/data` directory.
- `cargo make bakeddata foo` can be used to generate data in `provider/data/foo` only.
- `cargo make generate-readmes` - generates README files according to Rust docs. Output files must be committed in git for check to pass.
- `cargo make diplomat-gen` - recreates the Diplomat generated files in the `ffi/capi` directory.
- `cargo make diplomat-gen` - recreates the Diplomat generated files in the `ffi/capi/bindings` directory.
- `cargo make codegen` - recreates certain Askama generated files in the `ffi/capi/src` directory based on templates in `tools/make/codegen/templates`.

### Testing
Expand Down Expand Up @@ -222,7 +226,7 @@ We try to use [Conventional Comments](https://conventionalcomments.org/) for rev

### Social Contract

`ICU4X` project focuses on a fairly hermetic domain of software internationalization, which requires prior knowledge of the domain.
ICU4X project focuses on a fairly hermetic domain of software internationalization, which requires prior knowledge of the domain.
With that in mind, most engineers working on patch authoring and reviews are expected to be senior enough to be trusted with the quality of their additions to the code.

For those reasons, we are primarily placing **trust** in pull request authors to write high quality, readable, tested, maintainable and well documented code.
Expand Down
25 changes: 15 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# ICU4X [![Docs](https://docs.rs/icu/badge.svg)](https://docs.rs/icu) [![Build Status](https://github.com/unicode-org/icu4x/actions/workflows/build-test.yml/badge.svg)](https://github.com/unicode-org/icu4x/actions) [![Coverage Status (Coveralls)](https://coveralls.io/repos/github/unicode-org/icu4x/badge.svg?branch=main)](https://coveralls.io/github/unicode-org/icu4x?branch=main) [![Coverage Status (Codecov)](https://codecov.io/gh/unicode-org/icu4x/branch/main/graph/badge.svg)](https://app.codecov.io/gh/unicode-org/icu4x/tree/main)
<p align="center">
<a href="https://icu4x.unicode.org">
<img src="https://icu4x.unicode.org/icon_glow.png" alt="Logo" width="150" height="150">
</a>
</p>

Welcome to the home page for the `ICU4X` project.
# Welcome to ICU4X

`ICU4X` provides components enabling wide range of software internationalization.
It draws deeply from the experience of [`ICU4C`](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/), [`ICU4J`](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/) and [`ECMA-402`](https://github.com/tc39/ecma402/) and relies on data from the [`CLDR`](http://cldr.unicode.org/) project.
[![Docs](https://docs.rs/icu/badge.svg)](https://docs.rs/icu) [![Build Status](https://github.com/unicode-org/icu4x/actions/workflows/build-test.yml/badge.svg)](https://github.com/unicode-org/icu4x/actions) [![Coverage Status (Coveralls)](https://coveralls.io/repos/github/unicode-org/icu4x/badge.svg?branch=main)](https://coveralls.io/github/unicode-org/icu4x?branch=main) [![Coverage Status (Codecov)](https://codecov.io/gh/unicode-org/icu4x/branch/main/graph/badge.svg)](https://app.codecov.io/gh/unicode-org/icu4x/tree/main)


ICU4X provides components enabling wide range of software internationalization.
It draws deeply from the experience of [ICU4C](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/), [ICU4J](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/) and [ECMA-402](https://github.com/tc39/ecma402/) and relies on data from the [CLDR](http://cldr.unicode.org/) project.

ICU4X is fully implemented in the [Rust programming language](https://rust-lang.org).

The design goals of `ICU4X` are:

Expand All @@ -14,15 +23,11 @@ The design goals of `ICU4X` are:

***Stay informed!*** Join our public, low-traffic mailing list: [[email protected]](https://groups.google.com/a/unicode.org/g/icu4x-announce). *Note: After subscribing, check your spam folder for a confirmation.*

## Documentation

For an introduction to the project, please visit the [our website](https://icu4x.unicode.org/).

For technical information on how to use ICU4X, visit our [API docs (latest release)](https://docs.rs/icu/latest/) or [API docs (tip of main)](https://unicode-org.github.io/icu4x/rustdoc/icu/).
For more information, please visit [our website](https://icu4x.unicode.org/).

## Quick Start

An example `ICU4X` powered application in Rust may look like below...
An example ICU4X powered application in Rust may look like this:

`Cargo.toml`:

Expand Down
Loading