| 1 | Contributing Code to `Intl.js`
|
| 2 | ------------------------------
|
| 3 |
|
| 4 | Dev mode installation
|
| 5 | ---------------------
|
| 6 |
|
| 7 | To install the dependencies:
|
| 8 |
|
| 9 | npm install
|
| 10 |
|
| 11 | To run the unit tests:
|
| 12 |
|
| 13 | npm test
|
| 14 |
|
| 15 | To build files in `dist/` and `lib/`:
|
| 16 |
|
| 17 | npm run build
|
| 18 |
|
| 19 |
|
| 20 | Updating CLDR Data
|
| 21 | ------------------
|
| 22 |
|
| 23 | To specifically build files in `locale-data`:
|
| 24 |
|
| 25 | npm run build:data
|
| 26 |
|
| 27 | Note: this is completely optional since the regular `npm run build` will take care of it.
|
| 28 |
|
| 29 | Updating Test 262
|
| 30 | -----------------
|
| 31 |
|
| 32 | To specifically build files in `tests/test262`:
|
| 33 |
|
| 34 | grunt update-test262
|
| 35 |
|
| 36 | Note: be careful when attempting to update the tests.
|
| 37 |
|
| 38 | Source Code
|
| 39 | -----------
|
| 40 |
|
| 41 | All the source code is in `src/` folder, written as ES6 modules, and transpiled
|
| 42 | using `rollup` and `babel` into the `lib/` and `dist/` folders.
|
| 43 |
|
| 44 | The `dist/` is in git because of bower, make sure you commit those files as well.
|
| 45 |
|
| 46 | Release checklist
|
| 47 | -----------------
|
| 48 |
|
| 49 | * build all files using `npm run build`
|
| 50 | * run all tests using `npm test`
|
| 51 | * verify that [README.md] is updated
|
| 52 | * bump the version in [package.json]
|
| 53 | * commit to master
|
| 54 | * push to npm using `npm publish`
|
| 55 | * create a [new release] entry including the tag for the new version, being sure to document any deprecations
|
| 56 |
|
| 57 | [README.md]: https://github.com/andyearnshaw/Intl.js/blob/master/README.md
|
| 58 | [package.json]: https://github.com/andyearnshaw/Intl.js/blob/master/package.json
|
| 59 | [new release]: https://github.com/andyearnshaw/Intl.js/releases/new
|