Contributing to Seamless Interaction

We want to make contributing to Seamless Interaction as easy and transparent as possible.

Pull Requests

We 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.
Ensure the test suite passes.
Make sure your code is consistent with style guidance (below) and lints.
If you haven't already, complete the Contributor License Agreement ("CLA").
Add reviewer(s) for approval.

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.

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

Coding Style

4 spaces for indentation rather than tabs
119 character line length
PEP8 formatting

We recommend using ruff to format your code changes.

We use pre-commit to run ruff on every commit. To install pre-commit, you can run:

pip install pre-commit
pre-commit install  # install pre-commit hooks in the current repo

To run ruff locally, you can run:

ruff check .  # lint code
ruff check --select I .  # isort
ruff format .  # format code

If you deleted or recreated your .venv directory, you need to run pre-commit install again.

License

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