Сделайте код-ревью продуктивным, вызывающим положительные эмоции процессом, каким он и должен быть. Неважно, проверяют ваш код или же вы проверяете чью-то работу, получите продуманные инструкции, которые помогут избежать напряженных дебатов, неплодотворных придирок и узких мест — всего того, чего мы привычно ждем от код-ревью.
Научитесь здравому и внимательному подходу к код-ревью, который одной из первых стала применять автор книги — Эдриенн Браганца. Узнайте, как создать в команде доброжелательную атмосферу, четко согласовать цели код-ревью и ожидания от него, как подготовиться к любым изменениям и препятствиям, с которыми можете столкнуться. Освойте практики, которые можно адаптировать к тому, как работает ваша команда, познакомьтесь со множеством возможностей и решений, надежных сценариев, а также примеров из реальной жизни. Вскоре вы сможете построить высокоэффективный процесс код-ревью, который сделает ваш код лучше, а вашу команду сильнее.

Важная роль код-ревью.
Майк, разработчик из небольшой команды, закончил работу над новой функцией в пятницу. Он написал абсолютно новый парсер PDF-файлов для выделения сумм из присланных клиентами счетов. И успел он ровно в срок — до начала своего отпуска, который намеревался провести в Мексике. Конечно, не обошлось без костылей и палок, но все работало. Довольный собой, Майк, недолго думая, загрузил свой код в демосреду. Эдриенн, Эрика и Джастин — другие члены команды — согласились показать новую фичу генеральному директору, пока Майк будет отдыхать.
В понедельник утром Эдриенн начала тестировать новую программу и с удивлением обнаружила, что вычисления выполняются неправильно. Отладить код не получалось, поскольку в нем невозможно было разобраться. Призванные на помощь Джастин и Эрика спустя какое-то время лишь развели руками. Пока все трое пытались расшифровать загадочный код, Майк слал им картинки с пляжа — море, коктейли, закуски...
ОГЛАВЛЕНИЕ.
От издательства.
О научном редакторе русского издания.
Предисловие.
Введение.
Благодарности.
Об этой книге.
Для кого эта книга.
Структура книги.
О коде в книге.
Форум liveBook.
Об авторе.
Иллюстрация на обложке.
Часть 1 Основы код-ревью.
Глава 1. Важная роль код-ревью.
1.1. Кому адресована книга.
1.2. Как устроена книга.
1.3. Вам нужны код-ревью.
1.3.1. Улучшение приложений.
1.3.2. Углубление взаимопонимания.
1.4. Убеждаем коллег.
1.5. Улучшаем код-ревью.
Итоги.
Ссылки.
Глава 2. Раскладываем код-ревью по полочкам.
2.1. Системы код-ревью.
2.1.1. Ручные системы код-ревью.
2.1.2. Автоматизированные системы код-ревью.
2.1.3. Гибридные системы.
2.2. Принцип действия системы код-ревью.
2.2.1. Современный подход к процессам код-ревью.
2.2.2. Наше код-ревью (процесс на основе пул-реквестов).
2.3. Элементы отличного пул-реквеста.
2.3.1. Заголовок: вопрос «о чем?».
2.3.2. Описание: вопрос «зачем?».
2.3.3. Метки.
2.3.4. Состояния проверки.
2.4. Код-ревью. Участники и ожидания.
2.4.1. Ревьюер.
2.4.2. Автор.
2.4.3. Команда.
2.4.4. Руководители.
2.4.5. Организация.
Итоги.
Ссылки.
Глава 3. Первый процесс код-ревью вашей команды.
3.1. Определение целей.
3.1.1. Поиск багов.
3.1.2. Стабильность и сопровождаемость кодовой базы.
3.1.3. Передача знаний и обмен ими.
3.1.4. Менторство.
3.1.5. Ведение хроник и записей.
3.1.6. Выбор целей для код-ревью.
3.2. Выбор инструментов.
3.2.1. Оценка функций инструментов для код-ревью.
3.2.2. Выбор инструмента.
3.3. Создание свода правил.
3.3.1. Рабочий процесс.
3.3.2. На что обратить внимание.
3.3.3. Причины для блокировки пул-реквеста.
3.3.4. Политика одобрения.
3.4. Усовершенствование процесса.
3.4.1. Примеры усовершенствований.
Итоги.
Ссылки.
Часть 2 Совершенствуем процесс.
Глава 4. Регламент проверки кода.
4.1. Что такое регламент проверки кода.
4.2. Формулирование рабочих ожиданий.
4.2.1. Сценарий 1: быстрые и не слишком быстрые код-ревью.
4.2.2. Сценарий 2: несовпадение мнений.
4.2.3. Сценарий 3: одобрять или нет?.
4.3. Разработка регламента проверки кода.
4.3.1. Нужен ли нам регламент проверки кода?.
4.4. Что нужно включить в регламент проверки кода.
4.4.1. Неявные ожидания от код-ревью.
4.4.2. Адекватные сроки проверки.
4.4.3. Адекватные размеры пул-реквестов.
4.4.4. Выявление проблем.
4.4.5. Одобрение собственных пул-реквестов.
4.4.6. Недочеты (nitpicks).
4.4.7. Позитивная атмосфера.
4.4.8. Что делать в случае нарушения установленных правил?.
4.5. Регламент проверки кода — командный документ.
4.5.1. Необходимы изменения?.
4.5.2. И последнее.
Итоги.
Ссылки.
Глава 5. Преимущества автоматизации.
5.1. Автоматика как актив.
5.2. Подготовительные мероприятия перед внедрением автоматики.
5.2.1. Командное руководство по стилю.
5.2.2. Подходящие инструменты.
5.3. Помощь автоматики до начала код-ревью.
5.3.1. Форматирование.
5.3.2. Линтинг.
5.3.3. Статические анализаторы.
5.3.4. Автоматическое тестирование.
5.4. Помощь автоматики во время код-ревью.
5.4.1. Шаблоны пул-реквестов.
5.4.2. Валидаторы пул-реквестов.
5.4.3. Назначение ревьюеров.
5.4.4. Пропускной контроль пул-реквестов.
5.4.5. Напоминания и эскалации.
Итоги.
Ссылки.
Глава 6. Написание эффективных комментариев для код-ревью.
6.1. Что делает комментарии эффективными.
6.1.1. Объективность.
6.1.2. Конкретность.
6.1.3. Фокус на результат.
6.1.4. Примеры эффективных комментариев.
6.2. Тональность речи.
6.3. Заслуженная похвала.
Итоги.
Ссылки.
Часть 3 Нелегкие дилеммы и их решения.
Глава 7. Когда код-ревью — хуже некуда.
7.1. Болевые точки код-ревью.
7.1.1. Ленивые код-ревью.
7.1.2. Злобные код-ревью.
7.1.3. Код-ревью мутирующего кода.
7.1.4. Жестко регламентированные код-ревью.
7.2. Так что же делать?.
Итоги.
Глава 8. Ускорение код-ревью.
8.1. «У нас всего один сеньор для код-ревью».
8.2. «Я не понимаю пул-реквест».
8.3. «Слишком много файлов для проверки».
8.4. «Слишком большая функция для проверки».
8.5. «Из пустого в порожнее».
8.6. «Код нужно переделать» (иногда снова и снова).
Итоги.
Ссылки.
Глава 9. Устранение лазеек в процессе.
9.1. Как возникают лазейки?.
9.2. Лазейки (и способы их устранения).
9.2.1. Нечетко сформулированный процесс код-ревью.
9.2.2. Нехватка времени на код-ревью.
9.2.3. (Неправильная) настройка инструментов.
9.2.4. Отсутствие культуры обратной связи.
9.2.5. Одобрение как показатель.
9.2.6. Злоупотребление аварийными ситуациями.
Итоги.
Ссылка.
Глава 10. Аварийный план.
10.1. Что такое аварийный план?.
10.2. Что входит в аварийный план?.
10.2.1. Дерево решений.
10.2.2. Процесс авторизации.
10.2.3. Механизмы обхода.
10.2.4. Дальнейшие действия.
10.3. Когда задействовать аварийный план?.
Итоги.
Часть 4 Сочетание код-ревью с другими практиками.
Глава 11. Код-ревью и парное программирование.
11.1. Код-ревью или парное программирование?.
11.1.1. Парное программирование как дополнение к код-ревью.
11.1.2. Парное программирование не замена код-ревью.
11.2. Интеграция парного программирования.
11.2.1. Как убедить команду попробовать парное программирование.
11.2.2. Стили парного программирования.
11.2.3. Эффективное парное программирование.
Итоги.
Ссылки.
Глава 12. Код-ревью и моб-программирование.
12.1. Код-ревью или моб-программирование?.
12.1.1. Преимущества моб-программирования.
12.1.2. Моб-программирование как дополнение к код-ревью.
12.1.3. Моб-программирование не заменит код-ревью.
12.2. Интеграция моб-программирования с код-ревью.
12.2.1. Взаимодополняющие подходы.
12.2.2. Трудности моб-программирования.
Итоги.
Ссылки.
Глава 13. Код-ревью и искусственный интеллект.
13.1. Преимущества ИИ-ревьюера.
13.1.1. Ускорение код-ревью.
13.1.2. Повышение качества кода.
13.1.3. Консистентность код-ревью.
13.1.4. Масштабируемость для больших команд и кодовых баз.
13.2. Ограничения ИИ-ревьюера.
13.2.1. Трудности в понимании контекста и предметной области.
13.2.2. Сильная зависимость от набора обучающих данных.
13.2.3. Чрезмерное доверие к ИИ негативно влияет на квалификацию человека.
13.3. Чем может помочь ИИ-ревьюер?.
13.4. Интеграция ИИ с код-ревью.
13.5. Будущее код-ревью: сотрудничество человека и ИИ.
Итоги.
Ссылки.
Приложения.
Приложение A. Базовый шаблон регламента проверки кода.
Приложение Б. Базовый шаблон аварийного плана.
Б.1. Название аварийной процедуры.
Б.2. Дерево решений.
Б.3. Процесс авторизации.
Б.4. Механизмы обхода (и связанные с ними операции).
Б.5. Дальнейшие действия.
Б.5.1. Задокументируйте.
Приложение В. Шаблоны пул-реквестов.
Приложение Г. Список ресурсов.
Г.1. Список ресурсов по главам.
Г.2. Список линтеров по языкам.
Г.3. Список статических анализаторов по языкам.
Бесплатно скачать электронную книгу в удобном формате, смотреть и читать:
Скачать книгу По-моему, неплохо, Конструктивные код-ревью, Браганца Э., 2026 - fileskachat.com, быстрое и бесплатное скачивание.
Скачать pdf
Ниже можно купить эту книгу, если она есть в продаже, и похожие книги по лучшей цене со скидкой с доставкой по всей России.Купить книги
Скачать - pdf - Яндекс.Диск.
Дата публикации:
Теги: учебник по информатике :: информатика :: компьютеры :: Браганца :: код-ревью
Смотрите также учебники, книги и учебные материалы:
Предыдущие статьи:








