We want to make contributing to this project as easy and transparent as possible.
We mainly develop Faiss within Facebook. Sometimes, we will sync the github version of Faiss with the internal state.
We welcome pull requests that add significant value to Faiss. If you plan to do a major development and contribute it back to Faiss, please contact us first before putting too much effort into it.
- 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 lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
There is a Facebook internal test suite for Faiss, and we need to run all changes to Faiss through it.
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
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.
- 4 or 2 spaces for indentation in C++ (no tabs)
- 80 character line length (both for C++ and Python)
- C++ language level: C++17
By contributing to Faiss, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.