Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

15 lines (8 loc) · 1.28 KB

Contribution Guide

Thanks for your interest in contributing. This project was released to accompany a research paper for purposes of reproducability, and beyond its publication there are limited plans for future development of the repository.

Nonetheless, we welcome new pull requests and issues and will do our best to respond timely.

Before you get started

By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the LICENSE.

We ask that all community members read and observe our Code of Conduct.

Updating the version

To bump the version of this repository, first make sure everything works and check for lint errors using yarn lint. Then, run yarn version to bump the version of the package (please follow semantic versioning). This will update the version in package.json and create a new commit tagged with the version number. After building the project with yarn build, release the new package with npm publish. Then, push the commit and tag with git push and git push --tags. Finally, create a new release on GitHub with a changelog. To deploy the demo, run yarn deploy.