IIS_2023_1/README.md
2023-09-18 21:19:20 +04:00

8.1 KiB
Raw Permalink Blame History

IIS_2023_1

ПРАВИЛА ИГРЫ при сдаче лабораторных работ по предмету "Интеллектуальные информационные системы".

Всем Доброго времени суток! Настоятельно прошу прочитать этот файл от начала и до конца.

Задание на л/р

  1. Требования к языку программирования: python. Для выполнения лабораторных работ можно использовать любую IDE или текстовый редактор.

  2. Файл с заданиями находится в корне проекта (MetodichkaMII_MO.pdf).

  3. Наши л/р показаны на скриншоте. Или все 7 л/р по курсу "Машинное обучение". Обратите внимание, что лабораторные работы 3-7 выполняются на варианте данных вашей курсовой работы (Массивы данныхдля лабораторныхработ).

Воркфлоу по сдаче лабораторных работ

  1. Клонируем себе репозиторий на компьютер

git clone http://student.git.athene.tech/Alexey/IIS_2023_1.git

  1. Для выполнения очередной лабораторной работы необходимо завести отдельную ветку (перед этим необходимо выполнить команду git checkout master). Указанный формат наименования ветки <фамилия_имя_lab_номерабораторной> ОБЯЗАТЕЛЕН, в противном случае лабораторная работа не проверяется!

git checkout -b "zhelepov_alex_lab_1"

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

  1. В ветке создаём папку в аналогичном формате <фамилия_имя_lab_номерабораторной>, формат также ОБЯЗАТЕЛЕН, в противном случае лабораторная работа не проверяется!

mkdir zhelepov_alex_lab_1

  1. Весь код лабораторной работы и отчет должны находится внутри этой папки! То есть файловая структура репозитория должна иметь такой вид

ivanov_ivan_lab_1 zhelepov_alex_lab_1 README.md

  1. Отчет к лабораторной работе должен быть оформлен в виде файла readme.md, в котором Вы сможете дать краткое описание того, что делает Ваша программа. Очень хорошо (большой плюс при сдаче), если Вы опишите следующие пункты:
  • как запустить лабораторную работу
  • какие технологии использовали
  • что она делает
  • тесты, то есть несколько примеров входных и выходных значений

Небольшой гайд по синтаксису для оформления отчёта.

P.S. я знаю про хак "хочу скопировать у товарища этот волшебный readme и ничего не делать", но пожалуйста не делайте так (я буду обязательно проверять это)

  1. Как только Вы закончили работу над лабораторной работой, то находясь в своей ветке (убедитесь в этом пожалуйста, использую команду git branch - ваша текущая ветка будет подсвечена), вы должны закоммитить и запушить свои изменения в репозиторий, другими словами сохранить их в репозиторий.

git commit -m "zhelepov_alex_lab_1 is ready" git push origin

P.S. я знаю про хак "скопируй у товарища и закоммить - все равно он (я) смотреть не будет" - не сработает - давайте быть честными и делать все самостоятельно. А во-вторых, на реальной работе так не прокатит - скорее всего Вас просто уволят.

  1. После этого Вы должны перейти в наш git и создать merge request, назначив его на меня. Дополнительно лучше маякнуть меня в нашем телеграм-чате. Я проведу ревью и отпишу замечания, которые нужно будет исправить. Если все хорошо, то вмержу ваш pull-request в мастер-ветку. Данное состояние говорит о том, что ваша л/р принята.

  2. Важный момент: Устно я не принимаю лабораторные работы (подойти к компьютеру, посмотреть код, поставить оценку), только через репозиторий и после успешного code review ревью кода вашей л/р и ее результатов в виде отчета. Это делается для того, чтобы вы привыкали к воркфлоу, который применяется практически всеми IT-компаниями, где между разработчиками в основном общение идет через "текст". Что касается лабораторных работ в расписании - они используются в качестве консультаций, а сдача и проверка л/р идет только через репозиторий (то есть все замечания вы получаете на code review). Проверяю я обычно лабораторную в течение 1-3 дней после создания pull-request-а (всегда можно маякнуть меня в нашем telegram-чате).

Чек-лист для старост групп

  1. Убедиться, что все из списка зашли в телеграм-чат, где мы будем общаться + я буду публиковать различные объявления. ПОЖАЛУЙСТА, ОБРАТИТЕ НА ЭТО ВНИМАНИЕ и доведите до всех! В других каналах связя меня сложно выцепить или я могу пропустить сообщение.

  2. Убедиться, что все зарегистрировались на университетском git и добавились для работы с нашим репозиторием. А добавляться в этот репозиторий.

Полезные ссылки:

  1. Отличный тьюториал по гиту (рекомендую всем его пройти), вот тут

  2. Гайд по markdown тут

БОЛЬШОЕ СПАСИБО, что дочитали этот README до конца! И Удачи Вам в сдаче л/р и не только!