Трассируемость

От участников и рецензентов требуется заполнить шаблон запроса на вытягивание Pull-Request Template перед объединением.

Источник участника [2.ii]

В этом проекте в качестве подтверждения источника участника используется DCO (Подтверждение вклада). Более подробную информацию можно найти в политике DCO Фонда Eclipse (https://www.eclipse.org/legal/DCO.php).

Проекты Eclipse также требуют от участника наличия Соглашения о внесении вклада (Eclipse Contributor Agreement) в Фонде Eclipse (https://www.eclipse.org/legal/ECA.php).

Политика экспертной оценки [2.iii]

Все запросы на вытягивание должны пройти экспертную оценку и могут быть объединены только после одобрения двух коммиттеров (сопровождающих). Дополнительную информацию см. в разделе «Процесс разработки Eclipse» (https://www.eclipse.org/projects/dev_process/).

Непрерывная интеграция [2.iv]

Запросы на вытягивание должны проходить все задания в системе CI, даже если они одобрены. Кроме того, система CI всегда строит последнюю основную ветку для обеспечения функциональности.

Результаты CI публикуются и охватывают платформы x64, работающие под управлением Linux, macOS и Windows:

Регулярно тестируемые платформы в CI:

Они запускаются с использованием сборок выпуска, выпуска с отладочными символами, отладки и санитайзера адресов. Все сборки CI строят и выполняют все тесты, включая системные тесты.

Документация [3]

Документация по функциям [3.i]

Документацию по основным функциям iceoryx (отправка, получение данных) можно найти в разделах «Обзор» (./doc/website/getting-started/overview.md) и «Примеры iceoryx» (iceoryx_examples), включая понятное описание использования API iceoryx. Раздел «Руководство по настройке» (./doc/website/advanced/configuration-guide.md) дополняет документацию по использованию iceoryx.

Подробную техническую документацию о функциях iceoryx можно найти в разделе «Проектный документ» (./doc/design) с описаниями и диаграммами внутренних механизмов iceoryx.

Для новых функций рекомендуется сначала создать проектный документ, дополнительную информацию см. в Руководстве по внесению вклада (CONTRIBUTING.md#feature-request-and-bugs). Диаграммы в описании функций должны создаваться с помощью PlantUML (./doc/design/README.md#add-diagrams-using-plantuml).

В настоящее время ведётся работа по завершению документации существующих функций для достижения уровня качества 1.

Публичная документация по API [3.ii]

Публичный API документирован в виде комментариев Doxygen и доступен в качестве справочной информации по API на сайте iceoryx.io.

Лицензия [3.iii]

Лицензия для Eclipse iceoryx — Apache License 2.0, и каждый файл кода включает заявление о лицензии. Полный текст лицензии доступен в файле LICENSE. Проект включает файл NOTICE.md со ссылками на дополнительную информацию об этих лицензиях.

Eclipse iceoryx включает в себя некоторый сторонний контент, лицензированный как MIT или New BSD. Подробности также можно найти во включённом документе NOTICE.md#third-party-dependencies.

Заявление об авторских правах [3.iv]

Каждый файл исходного кода в Eclipse iceoryx имеет заголовок об авторских правах, который должен соответствовать этому стилю (CONTRIBUTING.md#header).

Задание CI проверяет с помощью ament_copyright, что все файлы соответствуют этому правилу.

Тестирование [4]

Каждая упаковка iceoryx содержит папку test, которая содержит подпапки для модульных и/или интеграционных тестов (./CONTRIBUTING.md#testing), написанных на основе тестовой среды Google. Все тесты выполняются на CI для каждого запроса на вытягивание для всех поддерживаемых платформ и содержатся в основной ветке. В настоящее время из-за ограниченной поддержки Windows существуют некоторые исключения для тестирования на CI.