Вклад в проект

Лицензионное соглашение участника

Вклад в этот проект должен сопровождаться Лицензионным соглашением участника. Вы (или ваш работодатель) сохраняете авторские права на свой вклад; это просто даёт нам разрешение использовать и распространять ваши вклады как часть проекта.

Структура репозитория

Пожалуйста, смотрите структуру репозитория.

Стиль

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

Код на языке Go следует руководству Uber по стилю программирования

C++ стиль программирования

Как правило, используйте clang-format для форматирования кода и следуйте рекомендациям clang-tidy.

Большая часть стиля кода основана на рекомендациях Google по стилю C++, за исключением:

• Исключения разрешены и поощряются там, где это уместно.
• Для защиты заголовков следует использовать #pragma once.

Другие советы

• Сообщение о фиксации Git должно быть содержательным, мы предлагаем императивные ключевые слова.
• Разработчик должен написать модульный тест (покрытие строк должно превышать 80%), тесты должны быть детерминированными.

Сборка

Предварительные требования

Docker

## запуск контейнера разработки
docker run -d -it --name scql-dev-$(whoami) \
         --mount type=bind,source="$(pwd)",target=/home/admin/dev/ \
         -w /home/admin/dev \
         --cap-add=SYS_PTRACE --security-opt seccomp=unconfined \
         --cap-add=NET_ADMIN \
         --privileged=true \
         secretflow/scql-ci:latest /bin/bash

# присоединение к контейнеру разработки
docker exec -it scql-dev-$(whoami) bash

Сборка и модульное тестирование

# предварительные требования
# spu нужен numpy
pip install numpy

# сборка SCQL-движка в режиме выпуска
bazel build //engine/exe:scqlengine -c opt

# тестирование

# запуск юнит-тестов для SCQL-движка
bazel test //engine/...

# сборка кода scdb
make

# запуск юнит-тестов scdb
go test ./pkg/...

Создание документации

# предварительные требования
pip3 install -U -r docs/requirements.txt

# создание HTML-документации, результат помещается в каталог 'docs/_build/html'
# создание документации на английском языке
make doc

# создание документации на китайском языке
make doc-cn