Участие в Open Source Milvus: руководство для начинающих
Программное обеспечение с открытым исходным кодом (OSS) — это прежде всего сотрудничество. Многие проекты с открытым исходным кодом запускаются отдельными разработчиками или организациями, но настоящая сила OSS исходит от его сообщества участников. Этими участниками могут быть разработчики, тестировщики, авторы текстов или дизайнеры, которые работают вместе, чтобы сделать проект лучше. Но управление вкладами большой и разнообразной группы требует эффективного и прозрачного процесса. Давайте посмотрим, как текущие вклады сообщества рассматриваются и объединяются с проектом с открытым исходным кодом.
Основная команда и сопровождающие
У каждого проекта с открытым исходным кодом есть основная группа сопровождающих или команда ведущих разработчиков. Эти сопровождающие определяют направление проекта, рассматривают вклады, обеспечивают качество кода и принимают ключевые решения. Они являются привратниками, которые решают, какие вклады принимаются и объединяются с основной кодовой базой.
Сопровождающие также управляют сообществом, создавая инклюзивную и дружелюбную среду. Они устанавливают правила и рекомендации для участия, которые часто документируются в файле CONTRIBUTING.md или аналогичном файле в репозитории проекта.
Процесс разработки программного обеспечения с открытым исходным кодом: рассмотрение и интеграция вкладов
В проектах с открытым исходным кодом вклады сообщества полезны для роста, а обеспечение качества и соответствия целям проекта требует структурированного процесса рассмотрения. Вот как вклады рассматриваются и интегрируются:
Отслеживание задач и обсуждениеУчастники обычно начинают с выявления ошибок или предложения функций через платформы вроде GitHub Issues. Сопровождающие и другие разработчики обсуждают лучший подход до написания какого-либо кода.
Отправка Pull Request (PR)Участники отправляют pull request со своими изменениями кода, объясняя, что они сделали, и связывая его с любыми релевантными задачами. PR — это основной канал для внесения изменений, будь то исправления ошибок, новые функции или улучшения.
Ревью кодаСопровождающие и участники сообщества рассматривают PR, проверяя функциональность, качество кода и соответствие рекомендациям проекта. Это ревью гарантирует, что вклад соответствует стандартам проекта и не вносит ошибок или уязвимостей безопасности.
Обратная связь и итерацииЕсли нужны изменения, рецензенты предоставляют обратную связь, а участники соответствующим образом дорабатывают свой PR. Этот цикл может повторяться несколько раз, чтобы отшлифовать код.
Автоматизированное тестированиеИнструменты непрерывной интеграции (CI) автоматически запускают тесты для PR, чтобы выявить любые проблемы на раннем этапе. Только когда код проходит все тесты, он рассматривается для слияния.
Слияние и выпускПосле того как PR одобрен и тесты успешно пройдены, сопровождающий объединяет вклад с основной веткой. Новый код теперь является частью проекта и будет включен в следующий выпуск.
Этот процесс рассмотрения и тестирования гарантирует, что вклады сообщества поддерживают качество и надежность проекта, одновременно способствуя сотрудничеству и улучшению.
Как отправить Pull Request в репозиторий с открытым исходным кодом на GitHub
GitHub — одна из самых популярных платформ для размещения проектов с открытым исходным кодом. Если вы впервые участвуете в проекте с открытым исходным кодом, отправка вашего первого pull request (PR) может стать захватывающим опытом. Вот пошаговое руководство, которое поможет вам сориентироваться в процессе.
Шаг 1: Сделайте форк репозитория
Первый шаг в участии в проекте — сделать форк репозитория. Форк — это ваша собственная копия репозитория, где вы можете свободно вносить изменения, не влияя на исходный проект.
Перейдите на страницу проекта на GitHub и нажмите кнопку Fork в правом верхнем углу страницы.
Это создаст копию репозитория в вашей учетной записи GitHub, позволяя вам вносить изменения без влияния на исходную кодовую базу.
Шаг 2: Клонируйте форкнутый репозиторий
Далее вам нужно клонировать ваш форкнутый репозиторий на локальный компьютер, чтобы вы могли работать с ним.
В вашем форкнутом репозитории на GitHub нажмите кнопку Code и скопируйте HTTPS- или SSH-ссылку.
Откройте терминал и выполните следующую команду, чтобы клонировать репозиторий:
git clone <repository-url>Это загрузит проект на ваш локальный компьютер.
Шаг 3: Создайте новую ветку
Хорошей практикой является создание новой ветки для каждой функции или исправления ошибки, над которыми вы работаете. Это помогает организовать ваши изменения и отделить их от основной ветки (обычно main или master).
Перейдите в папку репозитория:
cd <repository-folder>Создайте новую ветку и переключитесь на неё:
git checkout -b <new-branch-name>
Шаг 4: Внесите изменения
Теперь вы готовы вносить изменения в код. Это может включать исправление ошибок, добавление новых функций или улучшение документации.
Откройте файлы в предпочитаемом вами редакторе кода и реализуйте изменения, которые хотите внести.
После внесения изменений вы можете проверить свою работу локально, запустив тесты или проверив функциональность приложения.
Шаг 5: Зафиксируйте ваши изменения
После того как вы внесли и протестировали изменения, зафиксируйте их в локальном репозитории.
Подготовьте ваши изменения:
git add .Зафиксируйте ваши изменения с описательным сообщением:
git commit -m "Description of the changes made"
Шаг 6: Отправьте изменения на GitHub
Затем отправьте ваши изменения в ваш форкнутый репозиторий на GitHub.
Отправьте изменения в новую ветку, которую вы создали:
git push origin <new-branch-name>
Шаг 7: Создайте Pull Request
Теперь, когда ваши изменения отправлены в ваш форк на GitHub, пришло время создать pull request (PR), чтобы объединить их с исходным репозиторием.
Перейдите в ваш форкнутый репозиторий на GitHub, и вы увидите уведомление с предложением создать PR.
Нажмите кнопку Compare & Pull Request.
В форме PR укажите понятный заголовок и подробное описание внесённых вами изменений. Возможно, вам также потребуется выбрать ветку исходного репозитория, в которую вы хотите выполнить слияние.
Отправьте pull request, нажав кнопку Create Pull Request.
Шаг 8: Сотрудничайте и вносите правки
После отправки pull request сопровождающие проекта рассмотрят ваши изменения. Они могут попросить внести правки или предложить улучшения. Будьте готовы сделать дополнительные коммиты, чтобы учесть любые отзывы.
- Вы можете обновить pull request, отправив новые изменения в ту же ветку вашего форкнутого репозитория. PR автоматически обновится с вашими новыми изменениями.
Шаг 9: Слияние и празднование!
После того как ваш PR будет рассмотрен и одобрен, он будет объединён с кодовой базой исходного проекта. Поздравляем — вы официально внесли вклад в проект с открытым исходным кодом!
Заключение
Участие в разработке программного обеспечения с открытым исходным кодом — это полезный способ улучшить свои навыки программирования, сотрудничать с другими и внести вклад в сообщество разработчиков. Независимо от того, исправляете ли вы ошибки или добавляете новые функции, ваш вклад может иметь долгосрочное влияние. Понимание процесса разработки OSS и умение отправлять pull request на GitHub — необходимые навыки для любого разработчика, который хочет заявить о себе в мире open source. Так что вперёд — найдите проект, который вам интересен, и начните вносить вклад!
Читать далее
Balancing Precision and Performance: How Zilliz Cloud's New Parameters Help You Optimize Vector Search
Optimize vector search with Zilliz Cloud’s level and recall features to tune accuracy, balance performance, and power AI applications.
1 Table = 1000 Words? Foundation Models for Tabular Data
TableGPT2 automates tabular data insights, overcoming schema variability, while Milvus accelerates vector search for efficient, scalable decision-making.
Zilliz Cloud BYOC Upgrades: Bring Enterprise-Grade Security, Networking Isolation, and More
Discover how Zilliz Cloud BYOC brings enterprise-grade security, networking isolation, and infrastructure automation to vector database deployments in AWS