We want to make contributing to this project as easy and transparent as possible.
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 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.
To enhance the contribution process further, we have some additional guidelines for contributors:
-
Testing: We highly encourage you to test your changes thoroughly before submitting a pull request. Ensure that your code additions or changes do not introduce new issues and that existing functionality remains intact.
-
Documentation: Clear and well-structured documentation is essential. If you make changes to the code or APIs, please update the project's documentation accordingly. Well-documented code helps everyone understand and use the project effectively.
-
Communication: Effective communication is key to a successful open-source collaboration. If you have questions, suggestions, or need clarification on anything related to the project, feel free to engage with the community through discussions or the project's communication channels.
By contributing, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.