среда, 27 августа 2014 г.

И снова про code review или новая единица измерения качества (WTF/minute)

Интересная статья про инспекцию (рецензирование) кода (code review). Джим приводит интересную статистику и
дает советы по тому, как не тратить время во время code review.

Небольшой конспект и мои мысли. Можно не читать тут и идти сразу в оригинал.

1. Сам процесс должен быть легким. Групповое (когда назначается совещание и команда совместно смотрит код) ревью малоэффективно. Только 4% ошибок находится во время такого способа проведения инспекции. Лучше это делать по запросу по email или с помощью специальных инструментов. Тут наша горячо любимая Visual Studio отличилась. Ее возможность Code Review и так не ахти. А если вы храните ваши исходники в git-репозитории, то у вас нет даже ее. Приходится опять смотреть на сторонние инструменты. Недавно попробовали Upsource от Jetbrains работает в TFS-git. Пока завелось.

2. Сколько людей в команде надо привлекать к ревью? Джим считает, что всех приглашать не нужно - бесполезная трата денег. Некоторые исследования показывают, что разработчик глядя на свой код находит половину всех дефектов. Считается, что двое ревьеверов делают работу эффективнее, чем четверо. Возможно имеет эффект "размытия ответственности" - каждый думает "остальные точно проверят качественно".

3. Кроме количества ревьюверов важны еще и их навыки, а также то, как они разбираются в предметной области, к которой относится код. Иначе основным результатом ревью являются замечания по code-style и форматированию. У нас в команде действительно получается так, что специфичные области требующие углубленных знаний плохо инспектируются - тяжело смотреть код без понимания того, что и зачем он делает. Возможно парное программирование или некое его подобие облегчит проблему?

4. Используйте статический анализ. Он поможет улучшить качество ревью.

5. Критические области кода, на которые нужно обращать внимание при ревью:
  • Сетевое API
  • Код библиотек
  • Критическая бизнес-логика
  • Код по управлению, реализующий административный функционал
  • Критичные по безопасности и производительности места
  • Старый код, код, в котором раньше было много дефектов, переписываемый многими людьми
  • Код, который правят новички
  • Большие изменения (новое в старом коде)
  • Большой рефакторинг (изменения старого кода)
6. Получите от code review больше
Если вы неправильно его внедряете - вреда от него может быть больше, чем пользы. Но так как польза очевидна, то надо действовать аккуратно :)
Как уже упоминалось никаких совещаний, никаких наказаний. Старайтесь избегать замечаний по форматированию и code style. Не надо брать разработчиков за яйца - боюсь им это не понравится и в следующий раз ревью превратится или в фикцию, или попытку доказать кто тут на самом деле умный.
Инспекции кода - это не единственный инструмент обеспечения качества. Попробуйте делать просто больше тестов :) 

Удачи!

1 комментарий:

  1. Обсуждение темы в Facebook https://www.facebook.com/maxim.shulga.777/posts/887461807933408

    ОтветитьУдалить