Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (49 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 1.91 KB

Contributing to TorchX

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.
  4. Ensure the test suite passes.
  5. Make sure your code lints (see Lint + Pyre section below).
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

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.

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.

Development Setup

TorchX uses uv for dependency management:

# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install dependencies (creates .venv automatically)
uv sync --extra dev

# Run commands via uv
uv run pytest
uv run torchx --help

Lint + Pyre

Lint and type checking can be run via lintrunner:

uv run lintrunner init  # Sets up pyre
uv run lintrunner -a

Or activate the venv first:

source .venv/bin/activate
lintrunner init
lintrunner -a

License

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