You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+41-2Lines changed: 41 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,43 @@ To build all code paths, improve build times in VSCode, and prevent locking the
44
44
45
45
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.
46
46
47
+
### Building and Rebuilding Repo Data
48
+
49
+
In the ICU4X repository, there are a few types of locale data:
50
+
51
+
1. Test data: used for internal ICU4X development purposes only
52
+
- Downloaded data sources: `provider/source/tests/data`
- Set your desired locales and data markers on the bottom two lines.
81
+
- To overwrite the directly, add: `-W`
82
+
- To print verbose logs, add: `-v`
83
+
47
84
## Contributing a Pull Request
48
85
49
86
The first step is to fork the repository to your namespace and create a branch off of the `main` branch to work with.
@@ -79,10 +116,12 @@ There are various files that auto-generated across the ICU4X repository. Here a
79
116
need to run in order to recreate them. These files may be run in more comprehensive tests such as those included in `cargo make ci-job-test` or `cargo make ci-all`.
80
117
81
118
-`cargo make testdata` - regenerates all test data in the `provider/source/debug` directory.
82
-
- `cargo make bakeddata` - regenerates baked data in the `provider/data` directory.
83
-
- `cargo make bakeddata foo` can be used to generate data in `provider/data/foo` only.
119
+
- Tip: See [Building and Rebuilding Repo Data](#building-and-rebuilding-repo-data) for additional shortcuts.
120
+
-`cargo make bakeddata` - regenerates baked data in the `provider/data` directory.
121
+
-`cargo make bakeddata foo` can be used to generate data in `provider/data/foo` only.
84
122
-`cargo make generate-readmes` - generates README files according to Rust docs. Output files must be committed in git for check to pass.
85
123
-`cargo make diplomat-gen` - recreates the Diplomat generated files in the `ffi/capi` directory.
124
+
-`cargo make codegen` - recreates certain Askama generated files in the `ffi/capi/src` directory based on templates in `tools/make/codegen/templates`.
0 commit comments