Добро пожаловать в Volcano!

• Перед тем как начать
  • Код поведения
  • Ожидания сообщества
• Начало работы
• Ваш первый вклад
  • Найдите что-то, над чем можно поработать
    • Найдите хорошую первую тему
    • Работайте над проблемой
    • Отправьте отчет о проблеме
• Поток работы участников
  • Создание запросов на слияние (Pull Request)
  • Обзор кода
  • Тестирование

Перед тем как начать

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

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

Ожидания сообщества

Volcano — это проект сообщества, который стремится продвигать здоровое, дружелюбное и продуктивное окружение. Цель сообщества — создание системы Volcano, которая полезна для выполнения высокопроизводительных рабочих нагрузок, таких как AI, ML, глубинное обучение приложений поверх Kubernetes. Для создания такой системы Volcano требуется поддержка сообщества с аналогичными амбициями.

• Увидеть Членство в сообществе для списка различных ролей в сообществе. По мере постепенного внесения вклада можно продвигаться вверх по цепочке.# Начало работы

• Прочтите начало работы для разработки кода для Volcano

• Прочтите установку для инструкций сборки/развертки.

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

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

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

Найдите что-то, над чем можно поработать

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

Существует несколько репозиториев в организации Volcano. Каждый репозиторий имеет задачи, ориентированные на новичков, которые предоставляют хорошую первую задачу. Например, Volcano-Issues имеет метки помощь нужна и хорошая первая задача для задач, которые не требуют глубоких знаний системы. Мы можем помочь новым участникам, желающим работать над такими задачами. Еще один хороший способ внести свой вклад — найти улучшение документации, такое как отсутствующие/сломанные ссылки.#### Работа над проблемой

Когда вы готовы взяться за решение проблемы, можете назначить её себе. Просто ответьте с помощью команды /assign или /assign @ваш_логин на проблеме, затем бот назначит эту проблему вам, и ваше имя будет присутствовать в списке Assignees.

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

Хотя мы призываем всех вносить изменения в код, также очень ценится сообщение о проблеме. Проблемы должны быть открыты в соответствующем подрепозитории Volcano.

Пример: проблема Volcano должна быть открыта в Volcano.

Пожалуйста, следуйте указаниям по созданию проблемы, когда она открывается.

Процесс работы участника

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

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

• Создайте тематическую ветку от которой будет базироваться вклад. Обычно это основная ветка (master).
• Делайте коммиты логических единиц.
• Убедитесь, что сообщения коммитов имеют правильный формат (см. ниже).
• Внесите изменения в тематической ветке в персональной форке репозитория.
• Подайте pull-request в Volcano.
• Pull-request должен получить одобрение двух поддерживателей.

Создание pull-request

Pull-request часто называют просто "PR". Volcano обычно следует стандартному процессу создания pull-request на GitHub.Кроме вышеупомянутого процесса, бот начнёт применять структурированные метки к вашему pull request.

Бот может также делать некоторые полезные предложения по командам для выполнения в вашем pull request, чтобы облегчить проверку. Эти /command опции могут быть введены в комментариях для активации автоматического применения меток и уведомлений. См. его документацию по командам.

Проверка кода

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

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

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

Мы следуем приблизительному конвенции для сообщений коммитов, которая предназначена для ответа на два вопроса: что изменилось и почему. Заголовочная строка должна содержать "что" изменено, а тело коммита должно объяснять "почему".

scripts: добавлены тестовые коды для метаменеджера
```это добавляет некоторые юнит-тестовые коды для повышения покрытия кода для метаменеджера

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

Формат можно описать более формально следующим образом:

<подсистема>: <что изменилось>
<пустая строка>
<почему была сделана эта изменение>
<пустая строка>
<футер>

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

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

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

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

* Интеграция: Эти тесты охватывают взаимодействия компонентов пакета или взаимодействие между компонентами Volcano и компонентами управления Kubernetes, такими как API-сервер.
* End-to-end ("e2e"): Эти широкие тесты оценивают общее поведение системы и её целостность. Тесты end-to-end находятся в [Volcano e2e](https://github.com/volcano-sh/volcano/tree/master/test/e2e).Непрерывная интеграция будет выполнять эти тесты в запросах на слияние.