We want to make contributing to this project as easy and transparent as possible.
This project's source-of-truth is the version in Facebook's internal codebase, which is continuously synced with the GitHub mirror using ShipIt. Pull requests on GitHub are copied over using ImportIt (a companion tool for ShipIt).
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.
This project adheres to the PEP 8 style guidelines. It is linted using Flake8. Additional conventions from the Black formatter are sometimes adopted.
By contributing to torchbiggraph, you agree that your contributions will be licensed under the LICENSE.txt file in the root directory of this source tree.