We want to make contributing to this project as easy and transparent as possible.
... (in particular how this is synced with internal changes to the project)
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 and examples.
- Ensure the test suite passes.
- If you haven't already, complete the Contributor License Agreement ("CLA").
torchdata
enforces a fairly strict code format through pre-commit
. You can install it with
pip install pre-commit
or
conda install -c conda-forge pre-commit
To check and in most cases fix the code format, stage all your changes (git add
) and run pre-commit run
. To perform
the checks automatically before every git commit
, you can install them with pre-commit install
.
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.
By contributing to TorchData, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.