We want to make contributing to this project as easy and transparent as possible.
We actively welcome your pull requests, with the caveat that we will likely only accept bug fixes and optimizations, not new features.
- Fork the repo and create your branch from
main. - Ensure that the project builds and verify that it runs on a headset. We do not have any automated tests.
- Make sure your code lints.
- If you haven't already, complete the 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
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.
Project Flowerbed uses eslint and prettier to lint and format code.
You can format and lint manually by running:
$ yarn run lint
$ yarn 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.
By contributing to Project Flowerbed, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.