Вклад в pmemkv

• Открытие новых проблем
• Стиль кода
• Отправка запросов на вытягивание
• Создание новых движков
• Создание экспериментальных движков
• Расширение публичного API
• Настройка форка GitHub

Открытие новых проблем

Пожалуйста, регистрируйте ошибки или предложения как проблемы GitHub. Всегда приветствуются детали, такие как ОС и версия PMDK.

Стиль кода

• См. файл .clang-format в репозитории для деталей
• Отступ с помощью табуляции (ширина: 8)
• Не более 90 символов в строке
• Пробел перед '*' и '&' (а не после)

Если вы хотите проверить и отформатировать свой исходный код правильно, вы можете использовать опции CMake DEVELOPER_MODE и CHECK_CPP_STYLE. При включении включаются дополнительные проверки (cppstyle, пробелы и заголовки).

cmake .. -DDEVELOPER_MODE=ON -DCHECK_CPP_STYLE=ON

Если вы просто хотите отформатировать код, вы можете создать соответствующий таргет:

make cppformat

ПРИМЕЧАНИЕ: Мы используем специфический clang-формат — требуется именно версия 9.0.

Отправка запросов на вытягивание

Мы принимаем внешние вклады кода в PMEMKV через запросы на вытягивание GitHub.

Если вы добавляете новую функцию, реализуете новый движок или исправляете критическую ошибку, пожалуйста, добавьте соответствующую запись в ChangeLog под новейшим релизом.

ПРИМЕЧАНИЕ: Если вы решите реализовать изменения кода и внести их, пожалуйста, убедитесь, что вы согласны с тем, что ваш вклад может быть доступен под лицензией BSD-стиля, используемой для PMEMKV.

ПРИМЕЧАНИЕ: Отправка ваших изменений также означает, что вы подтверждаете следующее:

Сертификат разработчика происхождения 1.1

Делая вклад в этот проект, я подтверждаю, что:

(a) Вклад был создан полностью или частично мной, и у меня есть право представить его под открытой лицензией; или

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

(c) Вклад был предоставлен непосредственно мне другим лицом, которое подтвердило (a), (b) или (c), и я не модифицировал его.

(d) Я понимаю и соглашаюсь, что этот проект и вклад являются публичными, и что запись о вкладе (включая всю личную информацию, которую я предоставляю вместе с ним, включая мою подпись) ведётся постоянно и может быть распространена в соответствии с этим проектом или вовлечённой открытой лицензией(ами).

В случае сомнений привратник может попросить вас подтвердить вышеизложенное в письменной форме, например, по электронной почте или путём включения строки Signed-off-by: внизу комментариев к вашему коммиту.

Чтобы улучшить отслеживание того, кто является автором вклада, мы просим вас использовать ваше настоящее имя (не псевдоним), когда вы вносите изменения в PMEMKV:

Автор: Случайный разработчик J <random@developer.example.org>

Добавление новой зависимости

Добавление каждой новой зависимости (включая новый образ Docker и пакет) должно выполняться в отдельном коммите. Сообщение коммита должно быть:

Новая зависимость: dependency_name

лицензия: тег лицензии SPDX
происхождение: https://dependency_origin.com

Создание новых движков

Есть несколько мотивов для создания хранилища данных pmemkv:

• Использование новой/другой стратегии реализации
• Тестирование значительного изменения существующего движка
• Создание новой версии существующего движка с некоторыми изменениями

Далее мы рассмотрим шаги по созданию нового движка.

Выбор имени движка

• Относительно короткое (пользователям придётся это набирать!)
• Форматировано во всех строчных буквах
• Без пробелов или специальных символов
• Для этого примера: mytree

Создание заголовка движка

• Создайте файл заголовка src/engines/mytree.h

• Для новых движков используйте Должны быть правильно настроены:

• Персональный токен доступа для аккаунта GitHub должен быть сгенерирован.

  • Такой персональный токен должен быть установлен в репозитории pmemkv в качестве переменной DOC_UPDATE_GITHUB_TOKEN.

• Должна быть установлена секретная переменная DOC_UPDATE_BOT_NAME. В большинстве случаев она будет совпадать с именем аккаунта GitHub.

• Должна быть установлена секретная переменная DOC_REPO_OWNER. Имя аккаунта GitHub, который будет целью автоматического создания pull request с документацией. В большинстве случаев оно будет совпадать с именем аккаунта GitHub.

Чтобы включить автоматическую отправку образов в GitHub Container Registry, необходимо обновить существующую переменную среды CONTAINER_REG (определённую в файлах рабочего процесса в каталоге .github/), чтобы она содержала правильный адрес GitHub Container Registry (для форка реестра контейнеров пользователя).

Также должны быть настроены следующие переменные:

• GH_CR_USER — секретная переменная, которая должна быть установлена. Это аккаунт (с соответствующими разрешениями) для публикации образов в Container Registry (вкладка «Пакеты» в вашем профиле/организации GH).

• GH_CR_PAT — также должна быть настроена секретная переменная. Персональный токен доступа (только с разрешениями на чтение и запись пакетов), который должен быть создан, как описано здесь для выбранного аккаунта (пользователя, определённого в вышеуказанной переменной).