courses:programming:course_work:pull_request
Требования к созданию Pull-request по курсовой работой
Для допуска к защите курсовой работы необходимо сделать корректный Pull Request в репозиторий своей группы до установленного дедлайна: Структура курса и график работ
На пересдачах (дополенительная сессия и комиссия) крайний срок создания pull-request'а может отличаться. Внимательно следите за объявлениями в студенческом чате
Pull-request (помимо обычных требований) должен содержать:
- Инструкцию в формате markdown по сборке и запуску курсовой работы. Она должна включать полный список команд/шагов для этого и перечень зависимостей, которые требуется установить с инструкциями по их установке (или ссылки на официальные инструкции этих зависимостей).
- Полноценный отчёт по курсовой работе (Оформление пояснительной записки к курсовой работе)
- В отчёте должны быть примеры запуска курсовой работы. Должно быть не менее трех примеров запуска приложения с разными входными данными.
- Изображения (если курсовая предполагает работу с изображениями), для которых приведены примеры запусков, в количестве не менее трёх
- В отчёте должны быть примеры обработки ошибок курсовой работой. Примеры должны показывать, какое поведение в случае обработок ошибок является нормальным для вашей программы. При этом segmentation fault (core dumped) или просто завершение с ненулевым кодом – некорректная обработка ошибок. Например, пользователь указал неверный путь к файлу, а ваша программа завершается с сообщением «Путь к файлу указан неверно» - это является примером корректной обработки ошибки.
Для создания pull-request’а курсовая работа должна пройти предварительную автоматическую проверку на moodle:
Для групп ТОП-ИТ могут предъявляться повышенные требования к курсовой работе, в том числе и в предварительной автоматической проверке
Предварительная проверка не гарантирует полной работоспособности и корректности курсовой работы
Курсовая работа весеннего семестра должна содержать справку (help), доступную в графическом интерфейсе или в консоли в зависимости от реализации. Для CLI программ запуск программы без аргументов или с неправильными аргументами должен приводить к автоматическому отображению справки.
После указанного срока не допускается изменение содержимого pull-request’а, даже “косметических”/небольших изменений. Если пренебречь этим, то высок риск остаться без допуска к защите
Pull Request должен быть сделан в указанный выше срок и содержать описанные выше шаги. Нарушение этих правил может привести к невозможности защиты курсовой.
courses/programming/course_work/pull_request.txt · Последнее изменение: — sergey_tinyakov
