Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.73 KB
Raw

Contributing to TorchFix

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

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md.

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 (pytest tests).
  5. Make sure your code lints (see Linting section below).
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Linting

We use black, flake8, and mypy to lint the code. Configuration is available to run lints via pre-commit.

pip install ".[dev]"

Linting via pre-commit hook:

# manually run pre-commit hooks on all files (runs all linters)
pre-commit run --all-files

Manually running individual linters:

black .
flake8
mypy .

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.

License

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