Code Review - finance-google

Некоторые замечания по проведению Code Review.
1. Необходимо выделить кусок кода (функциональность) подлежащего
ревьюированию.
2. Код необходимо прежде подготовить, готовит тот, чей код подлежит
ревьюированию.
3. Код оформляется в один документ формата Word. При этом должны быть
соблюдены следующие условия:
a. Должны быть проставлены страницы.
b. Код должен быть форматирован для легкого чтения
c. Ключевые слова должны быть выделены
d. Должны включаться импорты классов, которые важны в данном случае
e. Код должен быть читабельным
f. Каждый класс (фрагмент кода) должен находится на отдельной странице.
g. На странице должно быть название ревьюируемого фрагмента кода
(название класса, компонента)
h. Должен включаться фрагмент, JavaDoc который важен в данном случае.
i. Рекомендуется помечать номера строк для более легкой навигации.
4. Документ содержащий код, должен быть разослан всем участникам участвующим
в ревьюировании. Причем сделать это необходимо заранее.
5. Каждый должен внимательно изучить код, т.е. провести его анализ, т.е. сделать
себе пометки и замечания.
6. Пункт №5 обязателен для выполнения, если кто-то его не выполняет, то на ревью
лучше не приходить, так как теряется смысл.
7. На код-ревью каждый должен прийти со своими замечаниями и пометками, и
распечаткой кода на руках.
8. Выделяется координатор, тот, кто ведет код ревью, что бы одна процедура не
обсуждалась очень долго и не перескакивали с одной проблемы на другую, т.е.
следит за процессом в целом.
9. Выделяется также протоколист, человек который ведет протокол заседания,
обычно это тот, чей код ревьюируют.
10. Результатом проведения ревью является протокол, который указывает все
замечания и пожелания по улучшению кода.
11. Код, который подлежал ревьюированию, должен быть соответствующим образом
исправлен, а протокол заседания должен быть выслан всем участникам.
12. Заседание по ревьюированию кода не должно превышать 1.5 - 2 часа.
13. На заседании обсуждается код, а не человек, который его писал. Поэтому
обсуждение кода не является «наездом» на конкретного человека и должно
восприниматься как само собой разумеющееся.