We want to make contributing to this project as easy and transparent as possible.
This code is a fully separated subset of code that is used in the internal Meta codebases. As such, we are treating this repository as a mirror of the internal codebase that is generalizable to the open source world. Since this repo is an example of how to use the Content Review Filters, we plan to keep the functionality limited to the core implementation logic.
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").
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.
Coding style is being enforced by prettier, please do not raise a pull request without having lint errors addressed.
By contributing to Content Review Filters, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.