We want to make contributing to this project as easy and transparent as possible.
Changes from Facebook employees are synced to the GitHub repo automatically. PRs from the community are imported into our internal source control and then pushed to GitHub.
For changes affecting both, native code and JavaScript, make sure to only create a single PR containing both parts of the code.
Although the Flipper desktop app is only released for macOS right now, it is possible to create Windows and Linux builds of the app. Please keep this in mind when dealing with platform-specific code.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
After opening a pull request or pushing to a branch, the CI will generate build artifacts for you for Linux, MacOS and Windows. You can download them from the GitHub Actions checks on your Pull Request.
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 Facebook'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.
Facebook 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.
We are using Prettier to format our source code. The styles are enforced via
eslint. Make sure everything is well formatted before creating a PR. Therefore,
run yarn lint and yarn fix to apply formatting fixes.
By contributing to Flipper, you agree that your contributions will be licensed under the LICENSE file.