Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 2.34 KB
Raw

Contributing to Immersive Web Emulation Runtime

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Make sure your code lints.
  4. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Meta's open source projects.

Complete your CLA here: https://code.facebook.com/cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Meta has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

Immersive Web Emulation Runtime uses eslint and prettier to lint and format code.

You can format manually by running:

$ npm run format

There are also VSCode extensions that can run those linters / formatters for you. Prettier has a VSCode Plugin, which allows you to format on save.

If you don't want to format on save, and want to format a single file, you can use Ctrl+Shift+P in VS Code (Cmd+Shift+P on macs) to bring up the command palette, then type Format Document to format the currently active file. Note that you should have the Prettier VS code plugin installed to make sure it formats according to the project's guidelines.

Testing

Immersive Web Emulation Runtime uses jest to conduct unit testing for all its classes. Before contributing, please make sure your change does not fail any of the existing jest tests. If you are adding new classes or new features, we request that you add relevant tests to ensure a high test coverage of the Immersive Web Emulation Runtime.

You can run tests manually by running:

$ npm run test

License

By contributing to Immersive Web Emulation Runtime, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.