If you're interested in developing and contributing on the polyfill itself, you'll need to
have [npm] installed and familiarize yourself with some commands below. For full list
of commands available, see package.json scripts.
$ git clone [email protected]:immersive-web/webxr-polyfill.git
$ cd webxr-polyfill/
# Install dependencies
$ npm install
# Build transpiled ES5 script
$ npm run build-script
# Build compressed ES5 script
$ npm run build-min
# Build ES module
$ npm run build-module
# Build all builds
$ npm run build
# Run tests
$ npm test
# Watch src/* directory and auto-rebuild on changes
$ npm watch
Right now there are some unit tests in the configuration and logic for how things get polyfilled. Be sure to run tests before submitting any PRs, and bonus points for having new tests!
$ npm test
Due to the nature of the polyfill, be also sure to test the examples with your changes where appropriate.
For maintainers only, to cut a new release for npm, use the [npm version] command. The preversion, version and postversion npm scripts will run tests, build, add built files and tag to git, push to github, and publish the new npm version.
npm version <semverstring>
This program is free software for both commercial and non-commercial use, distributed under the Apache 2.0 License.