🤯 ПОЛНЫЙ README ДЛЯ СТУДЕНТОВ

📋 13 Этапов

1. ✅ Создать ветку — любое имя
2. ✅ Дождаться файла — assignment.py создаётся автоматически
3. ✅ Выполнить задание — заполнить все функции (опять вайбим), получаем результат
4. ✅ Добавить PNG файлы — все графики закоммичены
5. ✅ Удалить лишние MD — только с отчетом README должно остаться
6. ✅ Добавить README — полный отчёт с статистикой по данным, как решали и т.д.
7. ✅ Создать PR — правильное описание
8. ✅ Добавить рецензентов — двух со-авторов
9. ✅ РЕЦЕНЗИРОВАТЬ АДЕКВАТНО — минимум 1 замечание + Request Changes
10. ✅ Ответить на замечания — внести улучшения
11. ✅ Дождаться Approve — от обоих рецензентов
12. ✅ Merge + Удалить ветку — запустить нужную итоговую автопроверку
13. ✅ Финальная проверка — все checks зелёные

⚠️ КРИТИЧЕСКИЕ ПРАВИЛА

Студент:

❌ Не засчитывается задание если:

• Нет рецензии (просто нажал merge и не дал советов коллегам)
• README пуст
• Остались лишние файлы
• Отсутствуют PNG
• Код не очень соответствует PEP8

✅ Засчитывается если:

• Все 13 этапов пройдены
• README полный с статистикой
• Двое одобрили ("Approve")
• Ветка удалена

Рецензент (если вы не справились как рецензент то задание в целом вам не засчитывается):

❌ Не засчитывается если:

• Не оставил комментарии
• Сразу нажал "Approve" без правок
• Замечания не конкретны

✅ Засчитывается если:

• Минимум 1 конкретное замечания
• Запросил правки ("Request changes")
• Проверил улучшения
• Потом "Approve"

Преподаватель:

❌ Отклоняет если:

• README формально составлен
• Нет нужных файлов
• Есть лишние markdown файлы
• Рецензия неадекватна

✅ Принимает если:

• Всё оформлено правильно
• Файлы на месте
• Лишних нет
• Рецензия содержательна

📁 Структура README

0. Информация о рецензируемых работах

   • gitverse профили

1. Информация о студенте

   • ФИО, группа, номер задания

2. Описание задания

   • Что нужно анализировать

3. Выполненные работы

   • Загрузка данных
   • Анализ целевой переменной
   • Анализ признаков
   • Визуализация

4. Статистика

   • Таблица с метриками
   • Ключевые числа

5. Ключевые находки

   • Выводы из анализа

6. Файлы

   • Список созданных и удалённых файлов

🎯 Примеры Рецензии

❌ Плохо:

Посмотри код
Исправь все ошибки

✅ Хорошо:

1. На строке 15: используешь pd.concat() 
   Рекомендую assign() - он производительнее:
   df.assign(target=y)
   
2. Docstring в load_data() не полный
   Добавь возвращаемый тип:
   """Returns: pd.DataFrame"""

3. В visualize_target() нет обработки ошибок
   Добавь try-except на случай если целевая переменная не найдена

Как минимум поправь пункты 1 и 2.

Не забудьте ответить рецензенту

✅ Спасибо за замечания!

Внесены улучшения:
1. ✅ Использую assign() вместо concat()
2. ✅ Добавил тип возврата в docstring
3. ✅ Добавил обработку ошибок

Готово к повторной проверке.

📞 Часто Задаваемые Вопросы

Q: Когда появится assignment.py?
A: В течение 30 секунд после создания ветки.

Q: Можно ли merge без рецензии?
A: Технически можно, но задание не засчитается!

Q: Что если рецензент не смог проверить?
A: Замените его на другого студента и попросите новую рецензию

Q: Как узнать что задание зачтено?
A: GitHub Actions покажет ✅ all checks passed

Q: Можно ли исправить рецензию?
A: Да, можно добавить ещё замечания прямо в PR

🏆 Успешное Выполнение

✅ Все 13 этапов выполнены
✅ Рецензия содержательна
✅ README полный
✅ Файлы на месте
✅ Checks прошли
✅ ЗАДАНИЕ ЗАЧТЕНО! 🎉