# Table of Contents

<!-- toc -->

- [Contributing to TorchMultimodal](#contributing-to-torchmultimodal)
- [Development Installation](#development-installation)
- [Development Process](#development-process)
- [License](#license)

<!-- tocstop -->

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

### 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 Meta'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.

Meta has a [bounty program](https://www.facebook.com/whitehat/) 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 Installation

### Install Dependencies

Same as in [README](README.md) with the exception of:
```
pip install -e ".[dev]"
```

## 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.
6. If you haven't already, complete the Contributor License Agreement ("CLA").

### Coding Style
TorchMultimodal uses pre-commit hooks to ensure style consistency and prevent common mistakes. Enable it by:

```
pre-commit install
```

After this pre-commit hooks will be run before every commit.

Ideally, flake and ufmt should be run via pre-commit hooks.
But if for some reason you want to run them separately follow this:

```
pip install -r dev-requirements.txt
flake8 (examples|test|torchmultimodal)
ufmt format (examples|test|torchmultimodal)
```

Alternatively, you can run on only those files you have modified, e.g.

```
flake8 `git diff main --name-only`
ufmt format `git diff main --name-only`
```

### Type checking

TorchMultimodal uses mypy for type checking. To perform type checking:

```
# on the whole repo
mypy

## only on modified files
mypy `git diff main --name-only`
```


### Unit Tests
Please add unit tests for adding a new feature or a bug-fix.

*Note: we are migrating from `unitest` to [`pytest`](https://docs.pytest.org/en/7.1.x/).
Please write your tests in pytest to help us with the transition.*

To run a specific test:
```
pytest tests/<test-module.py> -vv -k <test_myfunc>
# e.g. pytest tests/models/test_cnn_lstm.py -vv -k TestCNNLSTMModule
```

To run all tests:
```
pytest tests -vv
```

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