Внесение вклада в Faiss

Мы стремимся сделать внесение вклада в этот проект как можно более простым и прозрачным.

Наш процесс разработки

Основная разработка Faiss осуществляется внутри Facebook. Иногда мы синхронизируем версию Faiss на GitHub с внутренним состоянием.

Пулл-запросы

Мы приветствуем пулл-запросы, которые добавляют значительную ценность Faiss. Если вы планируете выполнить крупное развитие и внести его обратно в Faiss, пожалуйста, свяжитесь с нами до того, как вы вложите в это слишком много усилий.

1. Создайте форк репозитория и создайте ваш ветвь от master.
2. Если вы добавили код, который должен быть протестирован, добавьте тесты.
3. Если вы изменили API, обновите документацию.
4. Убедитесь, что тестовый набор проходит успешно.
5. Убедитесь, что ваш код соответствует стандартам форматирования.
6. Если вы еще не сделали этого, завершите [Соглашение о лицензии участника] ("CLA").

У Facebook есть внутренний набор тестов для Faiss, и нам нужно запускать все изменения в Faiss через него.

Соглашение о лицензии участника ("CLA")

Чтобы принять ваш пулл-запрос, нам нужно, чтобы вы представили CLA. Вам нужно сделать это только один раз для работы над любыми открытыми проектами Facebook.

Завершите ваше CLA здесь: https://code.facebook.com/cla

ПроблемыМы используем GitHub issues для отслеживания публичных ошибок. Пожалуйста, убедитесь, что ваше описание ясное и содержит достаточно инструкций для воспроизведения проблемы.Facebook имеет программу вознаграждения для безопасного раскрытия уязвимостей безопасности. В этих случаях, пожалуйста, следуйте процессу, описанному на этой странице, и не создавайте публичный issue.

Стиль программирования

• 4 пробела для отступов вместо табуляции
• Длина строки 80 символов
• C++03 для основного Faiss, C++11 для GPU части

Лицензия

Внесением вклада в Faiss вы соглашаетесь, что ваши вклады будут лицензированы под LICENSE файлом в корневом каталоге этого набора исходного кода.