Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 1.55 KB
Raw

Contributing to TorchData

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

... (in particular how this is synced with internal changes to the project)

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation and examples.
  4. Ensure the test suite passes.
  5. If you haven't already, complete the Contributor License Agreement ("CLA").

Code style

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.

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

Issues

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.

License

By contributing to TorchData, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.