Некоторые основные правила оформления кода при отправке на ревью:

• Соответствие стандартам. 2 Они должны охватывать все аспекты: от отступов и именования переменных до обработки ошибок и логирования. 1 Цель — чтобы любой разработчик из команды, глядя на код, мог сразу узнать его паттерны и правила именования. 1
• Ясные и однозначные имена. 2 Все переменные, поля, функции и другие элементы в коде должны иметь чёткие имена. 2
• Наличие комментариев. 24 Они должны ясно и чётко объяснять, зачем нужен каждый элемент. 2
• Подготовка списка изменений. 3 Перед отправкой на ревью автор решения должен подготовить его и обозначить в коде. 3

Также рекомендуется перед началом ревью подготовить список изменённых метаданных, а в коде отметить начало и конец изменения. 3