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

Название и описание

Это немного очевидно, но вместо того, чтобы сразу перейти к «изменениям» и начать просмотр, прочитайте заголовок и описание, может быть там есть что-то важное 🔥.

Обзор затем построчно

Перед просмотром построчно, мне нравится просматривать изменения, чтобы лучше понять, что на самом деле было изменено и что я просматриваю. Затем я просматриваю каждую строку кода, которая была изменена, и если я вижу что-то, с чем я не знаком, мне нравится открывать неизмененные строки и смотреть, была ли эта конкретная функция или переменная объявлена/импортирована где-то еще 😉.

Комментарии

Нет, не думаю 😜. Если мне что-то непонятно или я чего-то не понимаю, сразу комментирую, обычно, нажимаю «начать обзор», и просто добавляю все вопросы и комментарии в отзыв. Мне нравится гуглить, если я вижу что-то, чего раньше не видел, или если это выглядит очень интересно, например, это может быть определенный API 🏂.

Как писать вопросы и комментарии

Во-первых, будьте добры 💝. Когда я что-то спрашиваю, я обычно стараюсь задать это как открытый вопрос, а не как критику, т.е. «Любопытно, а зачем здесь нужна именно эта абстракция? Что вы думаете об использовании этого вместо этого? Это может помочь с производительностью, потому что…».
Мне нравится задавать вопрос, затем предлагать решение, которое могло бы быть лучше (я также могу ошибаться 😝), затем объяснять, почему я бы использовал свое решение вместо текущего. ❤️. Не забывайте также, что вы просматриваете код, а не просматриваете/судите автора пулл-реквеста 😃.
Я люблю эмодзи, использую их везде, даже в код-ревью 😆. На мой взгляд, смайлики придают сообщению как-то больше жизни 🌞. Это не то, что я рекомендую, но если вы хотите попробовать, вперед, ха-ха 😄.

Протестируйте его локально

Мне также нравится тестировать запрос на извлечение локально. Это помогает мне не только лучше понять изменения, но и немного поиграть и, возможно, предложить конкретное решение. Я не совершаю! Это не мой пулл-реквест, и я думаю, что автор пулл-реквеста лучше понимает внесенные им изменения и почему он решил это сделать, поэтому я просто предлагаю решение либо через Slack, либо просто добавлю его как комментарий к моему отзыву. Если есть изменения, которые вы видите, я запускаю сервер и смотрю, как он выглядит 👀.
При локальном тестировании я копирую имя ветки с GitHub/GitLab, прячу свои текущие изменения, если над чем-то работаю, извлеките ветку master, извлеките из ветки master, а затем извлеките ветку, которую я хочу просмотреть.

Вот как мне нравится делать обзоры кода, не стесняйтесь комментировать и давать любые отзывы 😇 😄.