Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 1.74 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Develop locally

Thre is no compilation step.

Update index.html to load local files

In index.html, comment <script type="module" src="https://cdn.skypack.dev/stereo-img"></script> and uncomment the lines below loading from local files.

Starting a local development server

Install dependencies with npm install

Run the local web server with npm start

Publishing to npm

To update the npm package

Run the following:

  • npm version minor
  • git push --follow-tags

Then a GitHub Action automatically publishes to npm.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.