60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
Contributing Code to `Intl.js`
|
|
------------------------------
|
|
|
|
Dev mode installation
|
|
---------------------
|
|
|
|
To install the dependencies:
|
|
|
|
npm install
|
|
|
|
To run the unit tests:
|
|
|
|
npm test
|
|
|
|
To build files in `dist/` and `lib/`:
|
|
|
|
npm run build
|
|
|
|
|
|
Updating CLDR Data
|
|
------------------
|
|
|
|
To specifically build files in `locale-data`:
|
|
|
|
npm run build:data
|
|
|
|
Note: this is completely optional since the regular `npm run build` will take care of it.
|
|
|
|
Updating Test 262
|
|
-----------------
|
|
|
|
To specifically build files in `tests/test262`:
|
|
|
|
grunt update-test262
|
|
|
|
Note: be careful when attempting to update the tests.
|
|
|
|
Source Code
|
|
-----------
|
|
|
|
All the source code is in `src/` folder, written as ES6 modules, and transpiled
|
|
using `rollup` and `babel` into the `lib/` and `dist/` folders.
|
|
|
|
The `dist/` is in git because of bower, make sure you commit those files as well.
|
|
|
|
Release checklist
|
|
-----------------
|
|
|
|
* build all files using `npm run build`
|
|
* run all tests using `npm test`
|
|
* verify that [README.md] is updated
|
|
* bump the version in [package.json]
|
|
* commit to master
|
|
* push to npm using `npm publish`
|
|
* create a [new release] entry including the tag for the new version, being sure to document any deprecations
|
|
|
|
[README.md]: https://github.com/andyearnshaw/Intl.js/blob/master/README.md
|
|
[package.json]: https://github.com/andyearnshaw/Intl.js/blob/master/package.json
|
|
[new release]: https://github.com/andyearnshaw/Intl.js/releases/new
|