Инструменты пользователя

Инструменты сайта


courses:programming:pr_kurs

Правила создания PR к курсовой работе

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

Например: если защита назначена на 11:40 14 мая, то PR должен быть сделан не позднее чем 23:59:59 12 мая.

Pull Request (помимо обычных требований) должен содержать:

  • Инструкцию по запуску Вашего приложения. Она должна включать полный список команд/шагов для этого и перечень зависимостей, которые требуется установить с инструкциями по их установке (или ссылки на официальные инструкции этих зависимостей).
  • Пример запуска приложения со скриншотами. Должно быть не менее трех примеров запуска приложения с разными входными данными.
  • Картинки (если курсовая предполагает работу с изображениями), на которых Вы запускаете программу в количестве не менее трёх
  • Примеры обработки ошибок вашей программой со скриншотами. Эти примеры должны показывать, какое поведение в случае обработок ошибок является нормальным для вашей программы. При этом segmentation fault (core dumped) или просто завершение с ненулевым кодом – некорректная обработка ошибок. Предположим, пользователь указал неверный путь к файлу, а ваша программа завершается с сообщением «Путь к файлу указан неверно» - это является примером корректной обработки ошибки.

Дополнительно курсовая работа должна пройти предварительную проверку на moodle:

Обратите внимание, что предварительная проверка не гарантирует полной работоспособности вашей курсовой работы

Для весеннего семестра: Обратите внимание, что ваша программа должна содержать справку (help), доступную в графическом интерфейсе или в консоли в зависимости от реализации. Для CLI программ запуск программы без аргументов или с неправильными аргументами должен приводить к автоматическому отображению справки.

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

Наличие отчета - обязательное условие для выставления оценки в ведомость.

Нарушение этих правил может привести к невозможности защиты курсовой.