Вклад в проект BK-CI

Команда «Лазурный кит» придерживается открытой позиции и приглашает разработчиков, разделяющих наши взгляды, к совместному участию в проекте. Прежде чем приступить к работе, внимательно ознакомьтесь с инструкциями ниже.

1. Кодекс лицензирования

Лицензия MIT является открытым лицензионным соглашением для BK-CI. Любой код, который вы предоставляете, также будет защищён этим соглашением. Перед предоставлением кода убедитесь, что вы согласны с условиями лицензии.

2. Проектная документация

Все функции и особенности должны иметь соответствующую проектную документацию. Документацию следует архивировать в каталоге docs/features, чтобы команда могла легко её просматривать, а будущие разработчики могли легко ознакомиться с особенностями проекта.

3. Вклад функций и особенностей

Если вы хотите внести свой вклад в проект BK-CI, предоставив новые функции или особенности, следуйте следующим шагам:

• Свяжитесь с командой «Лазурного кита», чтобы обсудить соответствующие функциональные требования;
• Как только команда одобрит функцию, создайте issue, чтобы отслеживать эту особенность. Issue должен содержать описание проблемы, которую необходимо решить, примеры использования, связанную проектную документацию, детали реализации и возможные проблемы;
• Предоставьте подробную проектную документацию команде «Лазурного кита»;
• Команда «Лазурного кита» определит приоритеты и сроки интеграции функции или особенности в проект;
• Завершите кодирование, модульное тестирование, тестирование сценариев использования и подготовку документации по использованию, убедившись в согласованности стиля кода;
• Отправьте Pull Request/Merge Request, включая документацию и код.
• После проверки функция или особенность будут объединены.

Обратите внимание: для обеспечения качества кода, особенно для крупных функций или особенностей, команда «Лазурного кита» предпочитает постепенный подход, разбивая большие изменения на несколько PRs/MRs. Это позволяет другим разработчикам легче отслеживать изменения. Крупные и единовременные изменения могут потребовать больше времени на проверку.

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

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

5. Правила фиксации в GIT

В разных командах и проектах используются разные системы управления проектами, поэтому существуют различные стандарты комментирования кода при фиксации изменений в системе контроля версий. Чтобы стандартизировать процесс фиксации информации о внесении изменений в различных командах, были введены специальные метки для классификации типов изменений:

git commit -m 'метка: краткое описание изменения issue #123'

Пример:

git commit -m 'исправление: проблема с задержкой выхода процесса worker-agent.jar на некоторых сторонних сборочных машинах #29'

6. Pull Request / Merge Request

Если у вас уже есть работа над существующим issue и вы нашли разумное решение, рекомендуется ответить на этот issue, чтобы команда «Лазурного кита» или другие разработчики и пользователи знали о вашем интересе к этой проблеме и о том, что у вас есть прогресс в решении. Это поможет избежать дублирования работы и неэффективного использования ресурсов. Команда «Лазурного кита» открыта для обсуждения решений и ожидает ваших PR/MR.

Процесс внесения исправлений:

• Создайте собственную ветку на основе ветки, затронутой issue;
• Создайте свою собственную ветку для исправления;
• Исправьте проблему;
• Добавьте новые тестовые сценарии использования. Если это исправление ошибки, убедитесь, что тесты не проходят без исправления кода. Постарайтесь охватить все возможные ситуации;
• Обновите документацию (если необходимо);
• Скомпилируйте и пройдите модульные тесты;
• Пройдите проверку и объедините изменения после одобрения.

Для исправления issue команда «Лазурного кита» ожидает, что один PR/MR будет включать все связанные материалы, включая код, документацию по исправлению и инструкции по использованию.

Более подробную информацию о процессе проверки можно найти в документе BK-CI review related process.

7. Issues

Команда «Лазурного кита» использует issues для отслеживания ошибок и функций.

При отправке сообщения об ошибке убедитесь, что вы проверили наличие похожих или существующих issue. Это позволит избежать дублирования.

Если вы уверены, что это новая ошибка, включите следующую информацию при отправке:

• Информация об операционной системе, которую вы используете;
• Текущая версия, например version, commitid;
• Журнал вывода соответствующего модуля при возникновении проблемы;
• Точные шаги для воспроизведения проблемы, например, предоставление связанного сценария для воспроизведения может быть более полезным, чем подробное описание.