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

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

Лицензия на код

MIT LICENSE — это лицензия с открытым исходным кодом для BK-CI. Код, предоставленный кем-либо, защищён этой лицензией. Перед тем как вносить свой код, убедитесь, что вы принимаете условия лицензии.

Проектный документ

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

Внести функциональность и функцию

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

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

Примечание: Чтобы обеспечить качество кода, для больших функциональностей и функций команда BlueKing обычно отправляет несколько PR/MR постепенно, чтобы соответствующие разработчики могли рассмотреть детали изменений. Проверка однократного и крупномасштабного коммита может занять больше времени.

Как начать

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

Спецификации фиксации GIT

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

git commit -m 'mark: comment of the commit issue #123'

Например:

git commit -m 'fix: the bug that the worker-agent.jar process has delayed exit on some third-party agents #29'

Описание меток

Запрос на вытягивание/запрос на слияние

Если вы уже работаете над существующей задачей и у вас есть разумное решение, вам рекомендуется ответить на задачу, чтобы команда BlueKing или другие разработчики и пользователи знали, что вы заинтересованы в задаче и добились положительного прогресса, что предотвращает повторение и позволяет избежать траты рабочей силы. Команда BlueKing придерживается открытого подхода и готова обсудить решения с вами. Мы надеемся, что вы отправите PR/MR.

Шаги для фиксации исправления:

1. Создайте форк ветки, затронутой задачей.
2. Создайте собственную ветку для исправления.
3. Исправьте задачу.
4. Добавьте новые тестовые случаи. При попытке исправить ошибку убедитесь, что код не проходит тестовые сценарии, пока ошибка не будет исправлена. Тестовые сценарии должны охватывать как можно больше сценариев.

• Обновите документацию (при необходимости).
• Успешно скомпилируйте и пройдите модульное тестирование.
• Проведите ревью. Объедините после прохождения.

Команда BlueKing надеется, что один PR/MR может охватить весь соответствующий контент, включая, помимо прочего, код, документацию и руководство пользователя.

Пожалуйста, обратитесь к BK-CI Review Process для соответствующего процесса проверки.

Проблемы

Команда BlueKing использует проблемы, чтобы отслеживать ошибки, функции и т. д.

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

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

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