Contributing to torchchat

October 3, 2024 ยท View on GitHub

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

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 is well-formatted using the repo linter. See "Linting" for details.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Linting

Install the lintrunner dependencies from the requirements file.

pip3 install -r install/requirements-lintrunner.txt

After making your changes locally, run the lintrunner and apply all suggestions to your changes. You can do this from the top-level torchchat directory - it will apply suggestions only to files that you have touched.

lintrunner -a

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 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 torchchat, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.