Советы для начала участия в проектах Ultralytics с открытым исходным кодом

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

Если ты хочешь внести свой вклад — например, написать документацию, проверить код или решить проблемы, — но не знаешь, с чего начать, или столкнулся с некоторыми проблемами, мы поможем тебе сделать первые шаги. В этой статье мы расскажем о нескольких советах, которые помогут тебе начать участвовать в проектах Ultralytics с открытым исходным кодом. Давай начнём!

Важность вклада сообщества Ultralytics#

Прежде чем перейти к тому, как внести свой вклад, давай ответим на вопрос, почему вклад участников так важен. Мы твёрдо верим в значимость вклада сообщества Ultralytics. Участвуя в наших проектах с открытым исходным кодом, ты не просто помогаешь нам создавать более качественное программное обеспечение. Участники играют ключевую роль в том, чтобы наши технологии оставались открытыми, совместными и постоянно развивались. Благодаря твоему вкладу наши проекты продолжают развиваться, остаются доступными и приносят пользу пользователям и разработчикам по всему миру!

Помимо создания передового программного обеспечения, участие в проектах Ultralytics — отличная возможность для твоего развития. Ты можешь совершенствовать навыки программирования, решения задач и командной работы, сотрудничая с опытными разработчиками, которые могут дать рекомендации и поделиться лучшими практиками. Твои усилия способны реально повлиять на инструменты, которыми пользуются тысячи людей по всему миру. Участие в нашем сообществе также поможет тебе расширить профессиональную сеть, открыть новые возможности и улучшить портфолио, чтобы выделиться среди соискателей.

Рис. 1. Причины внести свой вклад. Изображение: автор.

Как начать участвовать в проектах Ultralytics с открытым исходным кодом#

Отличное место для начала — официальное руководство Ultralytics для участников. В нём собраны лучшие практики и советы, которые помогут тебе получить максимум от своего вклада. Первый шаг — ознакомиться с тем, что уже входит в проект: изучить правила участия и погрузиться в код.

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

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

Различные направления для участия#

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

Вот некоторые из доступных вариантов:

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

Каждое из этих направлений предлагает уникальный способ внести свой вклад, и ты можешь выбрать то, которое лучше всего соответствует твоим сильным сторонам и интересам. Помни: любой вклад, каким бы небольшим он ни был, играет важную роль в развитии Ultralytics.

Рис. 2. В нашем растущем сообществе ценен каждый вклад. Источник изображения: Envato Elements.

Участие в разработке документации Ultralytics с открытым исходным кодом#

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

При написании или редактировании помни, что важно соблюдать правила проекта для поддержания единообразия. Вот несколько советов по форматированию:

• Всегда используй форматирование Markdown.
• Начинай каждый документ с понятного введения и используй простой и доступный язык.
• Используй маркированные списки, описательный текст для ссылок и изображения размером менее 1 МБ, чтобы страницы загружались быстро.
• Если у тебя есть вопросы по форматированию, простой способ перепроверить его — посмотреть, как оформлена предыдущая документация.

Рис. 3. Пример форматирования Markdown (слева) и визуализированного итогового документа (справа). Изображение: автор.

После подготовки черновика важно предварительно просмотреть его, локально собрав документацию. Так ты сможешь обнаружить проблемы до отправки. Для этого сначала клонируй репозиторий и перейди в каталог проекта:

Затем установи необходимые зависимости:

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

Ты можешь просмотреть локально собранную документацию, перейдя в браузере по адресу http://127.0.0.1:8000/.

Проверив ясность, точность и единообразие, ты можешь отправить запрос на включение изменений с понятным описанием созданного документа. Обязательно помести документ в подходящий раздел с учётом его содержания и назначения (руководства, решения, интеграции и т. д.). Также изучи файл index.md, чтобы найти соответствующие разделы, и общий файл mkdocs.yml; при необходимости внеси изменения. Внимание к деталям поможет сделать процесс проверки более гладким и обеспечить хорошую интеграцию твоего вклада в проект.

Что учитывать при участии в разработке кода с открытым исходным кодом#

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

• Избегай дублирования кода: по возможности повторно используй существующий код и своди к минимуму ненужные аргументы.
• Вноси небольшие целенаправленные изменения: сосредоточься на небольших точечных изменениях, а не на крупных модификациях.
• Упрощай или удаляй код: ищи возможности упростить код или удалить ненужные части.
• Пиши эффективные докстринги: чётко объясняй, что делает твой код, и добавляй ссылки на соответствующие ресурсы.
• Избегай ненужных зависимостей: добавляй зависимости только в случае крайней необходимости.

Рис. 4. Лучшие практики документирования исходного кода.

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

После написания фрагмента кода, который ты хочешь предложить, его необходимо протестировать. Для проверки изменений перед отправкой можно использовать такие фреймворки, как pytest. Единообразное форматирование кода — ещё один очень важный аспект твоего вклада. Такие инструменты, как Ruff Formatter, помогут поддерживать стилистическое единообразие и обнаруживать логические ошибки или несоответствия в коде.

Проверка запросов на включение изменений#

Проверка запросов на включение изменений (PR) — отличный способ внести свой вклад! PR создаётся, когда кто-то предлагает включить свои изменения в основной проект. Это помогает поддерживать стабильную работу проекта Ultralytics. Проверяя PR, убедись, что понимаешь причины внесения изменений. Автор должен чётко объяснить назначение и преимущества обновления, а в его PR должны быть подтверждения тщательного тестирования.

Рис. 5. Что такое запрос на включение изменений?

Давай рассмотрим несколько ключевых моментов, на которых стоит сосредоточиться.

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

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

Участие — это прежде всего сообщество#

Участие в проектах с открытым исходным кодом, таких как Ultralytics, может подарить тебе вдохновляющее ощущение единства с сообществом. Пишешь ли ты код, проверяешь PR, обновляешь документацию или участвуешь в обсуждениях — каждое усилие помогает проекту расти и развиваться. Ответы на вопросы или участие в обсуждениях на GitHub, Discord, сабреддите или других форумах — ценный способ внести свой вклад и наладить связи с другими участниками. Помни: твой вклад, каким бы небольшим он ни был, оказывает значительное влияние и помогает создавать совместную и поддерживающую среду для всех участников!

В Ultralytics мы увлечены развитием инноваций в сообществе открытого исходного кода. Следи за последними новостями, посещая наш репозиторий GitHub. Присоединяйся к нашему активному сообществу и узнай, как мы влияем на такие отрасли, как сельское хозяйство и промышленное производство.