Руководство для вкладчиков

• Перед началом работы
  • Кодекс поведения
• Начало работы
• Взаимодействие вкладчика
  • Создание запросов на слияние
  • Обзор кода
  • Тестирование

Перед началом работы

Кодекс поведения

Пожалуйста, прочтите и следуйте нашему Кодексу поведения.

Начало работы

• Разветвите репозиторий на GitHub
• Прочтите документацию для развертывания.

Ваш первый вклад

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

Взаимодействие вкладчика

Пожалуйста, не стесняйтесь задавать вопросы или отправлять запросы на слияние.

Это пример того, как выглядит процесс взаимодействия вкладчика:

• Создайте тематическую ветку от которой будет базироваться ваш вклад. Это обычно основная ветка.
• Делайте коммиты логических единиц.
• Убедитесь, что сообщения коммитов имеют правильный формат (см. ниже).
• Отправьте изменения в тематической ветке в персональную форк репозитория.
• Подайте запрос на слияние
• Запрос на слияние должен получить одобрение от поддерживателей.

Создание запросов на слияниеFabEdge обычно следует стандартному процессу GitHub pull request.

Обзор кода

Чтобы облегчить получение отзывов на ваш запрос на слияние, рассмотрите то, что рецензенты будут требовать от вас:

• следование правилам хорошего программирования.
• написание хороших сообщений коммитов.
• разделение больших изменений на логический ряд меньших патчей, которые индивидуально делают легко понятные изменения, а в совокупности решают более широкую задачу.

Формат сообщения коммита

Мы следуем приближенной конвенции для сообщений коммитов, которая предназначена для ответа на два вопроса: что изменилось и почему. Первая строка должна содержать "что" и должна быть не длиннее 70 символов, вторая строка всегда пустая, а остальные строки должны быть завернуты до 80 символов. Это позволяет сообщению быть легче читаемым на GitHub, а также в различных инструментах Git.

agent: добавлены тестовые коды для менеджера

Это добавляет некоторые юнит-тестовые коды для улучшения покрытия кода для агента.

Исправляет #666

Примечание: если ваш запрос на слияние не получает достаточно внимания, вы можете использовать Slack для связи с командой и получения помощи в поисках рецензентов.## Тестирование

Существует несколько типов тестов. Расположение тестового кода зависит от типа теста, а также спецификация необходимой среды для успешного выполнения тестов различается:

• Единичные тесты: Эти тесты проверяют, что конкретная функция работает так, как было запланировано. Исходный код для единичных тестов можно найти рядом с соответствующим исходным кодом внутри данного пакета. Они легко выполняются локально любым разработчиком.
• Интеграционные тесты: Эти тесты охватывают взаимодействия компонентов пакета или вза Müslüm, давай попробуем ещё раз:

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

Существует несколько типов тестов. Расположение тестового кода зависит от типа теста, а также спецификация необходимой среды для успешного выполнения тестов различается:

• Единичные тесты: Эти тесты проверяют, что конкретная функция работает так, как было запланировано. Исходный код для единичных тестов можно найти рядом с соответствующим исходным кодом внутри данного пакета. Они легко выполняются локально любым разработчиком.
• Интеграционные тесты: Эти тесты охватывают взаимодействия компонентов пакета или взаимодействие между компонентами и компонентами управления Kubernetes, такими как сервер API.
• End-to-end ("e2e"): Эти широкие тесты проверяют общее поведение системы и её целостность.

Непрерывная интеграция будет выполнять эти тесты для запросов на слияние.