Проверка кода и утверждения

Проверки кода — краеугольный камень современной разработки программного обеспечения. Это систематическая проверка исходного кода коллегами, позволяющая находить и исправлять ошибки, которые остались незамеченными на начальном этапе разработки.

Основные цели включают:

• Повышение качества кода: раннее обнаружение ошибок, уязвимостей безопасности и недостатков проектирования.
• Обмен знаниями: распространение понимания кодовой базы среди команды.
• Наставничество: опытные разработчики помогают начинающим, а каждый учится на разных точках зрения.

На GitHub процесс проверки кода обычно проходит следующие этапы:

1. Автор создаёт запрос на включение изменений (PR) со своими изменениями.
2. Автор назначает проверяющих или запрашивает их участие.
3. Проверяющие изучают код, оставляя комментарии и предложения.
4. Автор учитывает отзывы, отправляя новые коммиты в ветку PR.
5. После этого проверяющие одобряют изменения.
6. Наконец, PR объединяется с основной веткой.

Хорошая проверка кода — это не только поиск ошибок; она помогает улучшить общее состояние проекта. При проверке учитывайте:

• Корректность: выполняет ли код предназначенную ему задачу? Есть ли пограничные случаи?
• Читаемость: легко ли его понять? Понятны ли имена переменных?
• Удобство сопровождения: смогут ли другие разработчики легко изменить или расширить этот код позже?
• Производительность: есть ли очевидные неэффективные решения?
• Безопасность: не создаёт ли код уязвимостей?

Как проверяющий, вы всегда должны давать конструктивные и уважительные отзывы. Помните: вы проверяете код, а не человека, который его написал.

Советы по формулировке отзывов:

• Будьте конкретны: указывайте точные строки кода.
• Объясняйте «почему»: не просто говорите «измените это», а объясняйте, *почему* это нужно изменить.
• Предлагайте решения: предлагайте альтернативные подходы или фрагменты кода.
• Будьте доброжелательны: используйте вежливые формулировки и исходите из добрых намерений.

GitHub предоставляет мощные инструменты для упрощения процесса проверки:

• Комментарии к строкам: нажмите строку на вкладке «Изменённые файлы», чтобы добавить комментарий непосредственно к ней.
• Предложения: вы можете предложить конкретные изменения кода, которые автор применит одним нажатием.
• Итоговая проверка: в конце можно отправить итоговую проверку со статусом «Комментарий», «Одобрить» или «Запросить изменения».

Предложения особенно полезны для небольших и понятных улучшений:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Если вы автор запроса на включение изменений, крайне важно отвечать на отзывы. Это показывает вашу вовлечённость и стремление улучшить код.

Отвечая на комментарии:

• Подтверждайте получение: отвечайте на каждый комментарий, даже если просто написать «Хорошее замечание!» или «Готово».
• Вносите изменения: отправляйте новые коммиты в ветку PR. GitHub автоматически обновит PR.
• Закрывайте обсуждения: после учёта комментария отметьте его на GitHub как «Решено».
• Задавайте вопросы: если вы не понимаете предложение, попросите разъяснения.

Статус «Одобрено» — это ясный сигнал, что проверяющий удовлетворён изменениями в запросе на включение изменений. Многие репозитории настроены так, чтобы перед объединением PR требовалось как минимум одно (или несколько) одобрений.

Одобрение означает, что проверяющий считает код:

• Соответствующим требованиям.
• Хорошо написанным и удобным для сопровождения.
• Учитывающим все существенные замечания.

Это зелёный свет для интеграции!

Иногда запрос на включение изменений требует дополнительной работы, прежде чем его можно будет объединить. В таких случаях проверяющий может выбрать статус проверки «Запросить изменения».

Этот статус ясно сообщает, что:

• Есть блокирующие проблемы, которые необходимо устранить.
• PR нельзя объединить, пока эти изменения не будут внесены и проверяющий не даст новое одобрение.

Используйте этот вариант, когда проблемы существенны и не позволяют считать код приемлемым.

Чтобы проверки кода приносили максимальную пользу, авторам и проверяющим следует соблюдать несколько лучших практик:

• Делайте PR небольшими: небольшие PR проще и быстрее проверять.
• Пишите понятные описания: авторы должны подробно описывать PR и приводить контекст.
• Не затягивайте: проверяющим следует стараться быстро проводить проверки, а авторам — оперативно отвечать.
• Автоматизируйте всё возможное: используйте линтеры и автоматические тесты, чтобы обнаруживать простые проблемы до проверки.
• Учитесь на проверках: воспринимайте каждую проверку как возможность учиться и совершенствоваться.

Исходя из изученного, какие из перечисленных действий считаются хорошими практиками участия в проверках кода?

Вы познакомились с миром проверок кода и функциями одобрения GitHub! Мы рассмотрели, почему проверки важны для качества кода и обмена знаниями, типичный процесс проверки и ключевые элементы хороших практик.

Помните: всегда давайте конструктивные отзывы, используйте такие инструменты GitHub, как предложения, и соблюдайте лучшие практики как при проверке, так и при ответе на отзывы. Одобрения и запросы изменений — важные сигналы для эффективного управления вашими PR.

Продолжайте практиковаться, чтобы стать ценным участником команды!