Проверка кода — это сложно. Запросы на вытягивание, которые я рассмотрел, были для Мой фотохаб проект.

Проверка кода впервые в жизни заставила меня осознать, насколько это сложная задача. Как начинающий рецензент кода, я поймал себя на том, что смотрю на код, размышляя о том, что можно сделать, чтобы сделать его лучше. Чувствую себя потерянным. Я придумал несколько посредственных предложений. Ничего особенного. Ничего, что я чувствовал бы действительно удовлетворенным предложением. Потом пришел профессор Дэйв сделать обзор кода по тому же запросу на вытягивание, который я просматривал. Я просто сидел, изумленный деталями, на которые он смотрел, и всем тем, что я пропустил. Он предложил важные вещи, такие как улучшение логики программирования, и второстепенные, такие как обновление описания проекта. Я мог бы предложить и эти мелкие проблемы; лучшее описание проекта, лучший логотип, который идет с проектом вместо логотипа React по умолчанию, и создание дополнительных проблем для определенных вещей. Почему я упустил из виду очевидное, на что так элегантно и непринужденно указал профессор Дейв?
Ну, я был настолько зациклен и перегружен попытками найти что-то большое, что предположил, что мои чувства полностью отключились от простых вещей. Это заставило меня осознать, насколько мне нужно практиковаться в чтении кодов других людей и критическом осмыслении их. Как и в овладении любым навыком, умение быть хорошим рецензентом кода требует времени, терпения и практики.


Некоторые рекомендации по обзору кода 🌱

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


Время. Внимание. Общение ⏳‼️

Хороший обзор требует времени и внимания. Это требует от нас критического осмысления логики программирования. Новичкам может показаться ошеломляющим смотреть на код, написанный кем-то другим, чтобы предложить что-то осмысленное. Есть страх ошибиться. Страх обидеть человека, пишущего код. Я знаю, потому что я чувствовал все это. Однако в разработке с открытым исходным кодом всегда важно оставаться вежливым и уважительным в общении, давая конструктивную обратную связь. Иногда мы можем не согласиться с обзором, но если мы это сделаем, мы должны сообщить об этом вежливо.

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

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


Начните с малого 🐌 🌱

Если вы новичок, начните с малого и учитесь у других. Я узнал много важного, читая отзывы профессора Дейва. Затем я понял, что, видя, как более опытные люди проверяют код, я могу стать лучше. Я сделал некоторые заметки о том, чему научился, прочитав множество его обзоров кода на GitHub. Я превратил эти вещи в своего рода контрольный список:

  • Задавайте конкретные вопросы относительно определенных строк кода, если они неясны.
  • Ищите неиспользуемые зависимости и способы оптимизации package.json.
  • Посмотрите на код в контексте всей кодовой базы.
  • Оставьте несколько слов поддержки, чтобы указать, что разработчик делает правильно!
  • Сосредоточьтесь на функциональности и совместимости.
  • Ищите четкие имена и правильные соглашения об именах.
  • При просмотре файлов README или CONTRIBUTING.md обратите внимание на согласованность стиля, форматирования, орфографии и грамматики.
  • Убедитесь, что дизайн и пользовательский интерфейс выглядят хорошо.
  • Убедитесь, что модульные тесты правильно разработаны для кода.
  • Убедитесь, что код соответствует определенному предоставленному руководству по стилю.


Мои обзоры кода

Вот обзоры кода, которые я сделал за последние несколько дней. Нажмите на ссылку, чтобы просмотреть весь обзор 🙂

Предлагая изменения, я также предоставил обоснование предложения изменений и спросил мнение разработчика. Это позволяло общаться профессионально и вежливо.



Обзор 1

Описание изображения



Обзор 2

Описание изображения


В linters мы доверяем 🚀

Автоматические средства проверки кода и статические анализаторы инструментов могут помочь рецензенту сэкономить много времени на поиске глупых опечаток или стилистических ошибок. Линтеры и сканеры действуют как проверки орфографии и грамматики кода. Избавившись от головной боли, связанной с форматированием и другими стилистическими проблемами, рецензент может сосредоточиться на фактической логике кода. Как рецензенты кода, важно использовать доступные автоматические средства проверки кода, чтобы сэкономить время и здравомыслие.


Закрытие мыслей о продуктивности 💭

Если вы, как и я, любите читать о психологии и продуктивности, Это отличная статья!