itsecd / ptm-2

Технологии и методы программирования. 3 курс. Лабораторная 2.

Технологии и методы программирования

Таблица с успеваемостью

Лабораторная 2 "Code review"

В рамках данной лабораторной работы требуется продемонстрировать свою способность проводить code review.

Задание на лабораторную работу

1. Взять / получить код на ревью.
2. Произвести ревью, руководствуясь материалом лекции.
3. Продемонстрировать ревью преподавателю.

Варианты выполнения лабораторной работы

В вариантах сдачи данной лабораторной предусмотрена некоторая гибкость:

1. Создать review в виде простого документа на любой код (не в виде PR, а просто на код в статичной его версии), и переслать преподавателю любым способом - telegram/discord.
2. Сделать ревью в собственном репозитории - создать в нем ветку, добавить в нее код, сделать PR и произвести на него ревью. После чего переслать ссылку на ревью преподавателю.
3. Сделать ревью кода в данном репозитории - преподаватель добавит вас в репозиторий в качестве коллаборатора, после чего отправит вам на ревью свой PR. How the turntables.

При 1 и 2 варианте сдачи код на ревью вам придется подбирать самостоятельно. Очевидно, что при этом выбранный вами код должен обладать достаточным объемом, а его ревью должно иметь смысл.
При 3 варианте выполнения работы вы лишены мук подбора подходящего для ревью кода.

Условия сдачи

В каждом отдельном комментарии к коду вы должны указать следующую информацию:

• Какого рода проблема в нем присутствует - нарушение стандартов кодирования, неоправданная цикломатическая сложность, комбинаторный взрыв, мертвый код, нарушение DRY/SOLID/CUPID и т.д.
• Каким образом вы предлагаете ее решить - переименовать переменные, удалить фрагмент кода, изменить условие проверки, вынести значение в качестве параметра и т.д. (желательно с собственным примером кода, благо md-разметка позволяет его оформить)

Ремарки:

Обращайте внимание на:

• Ошибки в синтаксисе языка/ реализациях алгоримов и логики,
• Эффективность применения алгоритмов и структур кода,
• Качество декомпозиции кода,
• Читаемость кода,
• Code smells,
• Потенциальные проблемы с безопасностью и производительностью.

Если вы столкнулись с непреодолимыми трудностями в ходе выполнения лабораторной работы, вы можете задать вопрос в:

• телеграм-чате предмета,
• телеграм-чате вашего курса,
• канале в дискорде.