Вклад в YOLOv5 🚀

Мы ценим ваш вклад! Мы хотим сделать участие в проекте YOLOv5 максимально простым и прозрачным, будь то:

• сообщение об ошибке;
• обсуждение текущего состояния кода;
• отправка исправления;
• предложение новой функции;
• становление сопровождающим.

YOLOv5 работает так хорошо благодаря нашим совместным усилиям сообщества, и каждое небольшое улучшение, которое вы вносите, будет помогать расширять границы возможного в области искусственного интеллекта 😃!

Отправка запроса на включение (PR) 🛠️

Отправить PR легко! Этот пример показывает, как отправить PR для обновления requirements.txt за 4 шага:

1. Выберите файл для обновления

Выберите requirements.txt, который нужно обновить, щёлкнув по нему на GitHub.

2. Нажмите «Редактировать этот файл»

Кнопка находится в верхнем правом углу.

3. Внесите изменения

Измените версию matplotlib с 3.2.2 на 3.3.

4. Предварительный просмотр изменений и отправка PR

Щёлкните на вкладке Предварительный просмотр изменений, чтобы проверить обновления. Внизу экрана выберите «Создать новую ветку для этого коммита», присвойте ветке описательное имя, например fix/matplotlib_version, и нажмите зелёную кнопку Предложить изменения. Всё готово, ваш PR отправлен в YOLOv5 на рассмотрение и утверждение 😃!

Рекомендации по PR

Чтобы ваша работа была интегрирована максимально плавно, мы рекомендуем вам:

• ✅ Убедитесь, что ваш PR актуален с веткой ultralytics/yolov5 master. Если ваш PR отстаёт, вы можете обновить свой код, нажав кнопку «Обновить ветку» или выполнив git pull и git merge master локально.

• ✅ Убедитесь, что все проверки непрерывной интеграции (CI) YOLOv5 проходят.

• ✅ Сократите изменения до минимума, необходимого для исправления ошибки или добавления функции. «Не ежедневный прирост, а ежедневное уменьшение, отсекайте лишнее. Чем ближе к источнику, тем меньше потерь» — Брюс Ли.

Сообщение об ошибке 🐛

Если вы обнаружите проблему с YOLOv5, отправьте сообщение об ошибке!

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

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

• ✅ Минимальным – Используйте как можно меньше кода, который всё ещё вызывает ту же проблему.
• ✅ Полным – Предоставьте все части, необходимые кому-то другому для воспроизведения вашей проблемы в самом вопросе.
• ✅ Воспроизводимым – Протестируйте код, который вы собираетесь предоставить, чтобы убедиться, что он воспроизводит проблему.

В дополнение к вышеуказанным требованиям, для Ultralytics для оказания помощи ваш код должен быть:

• ✅ Актуальным – Убедитесь, что ваш код соответствует текущему GitHub master. И если необходимо, получите новую копию с помощью команд git pull или git clone, чтобы убедиться, что ваша проблема уже не была решена предыдущими фиксациями.

• ✅ Unmodified – Ваша проблема должна воспроизводиться без каких-либо изменений в кодовой базе этого репозитория. Ultralytics не предоставляет поддержку для пользовательского кода ⚠️.

Если вы считаете, что ваша проблема соответствует всем вышеуказанным критериям, пожалуйста, закройте эту проблему и создайте новую, используя шаблон 🐛 Bug Report (ссылка) и предоставьте минимальный воспроизводимый пример, чтобы помочь нам лучше понять и диагностировать вашу проблему.

License

Делая свой вклад, вы соглашаетесь, что ваши материалы будут лицензированы под лицензией AGPL-3.0.