Software Engineering
July 29, 2021
Как будут ревьюить твой код
Ревьюер (обычно) не несет ответственности за код. Его задача — помочь. Если помогать долго и трудно, никто это делать не будет. Посмотрят поверхностно на код-стайл и махнут рукой. Поэтому надо сделать так, чтобы ревьюер мог легко и комфортно вникнуть в суть изменения. Поэтому:
- Заголовок коммит-месседжа должен содержать самую суть. Он должен быть максимально конкретным, но при этом быть понятным каждому, кто активно работает с репозиторием.
- Тело коммит-месседжа должно отвечать на вопрос "зачем". И, возможно, освещать подробности того, что именно сделано. Только в самых очевидных случаев тело коммит месседжа можно опускать.
- Дифф должен быть минимальным. Нелья делать изменения "заодно". Разные задачи — разные изменения. Правило
пионераскаута — это хорошо, но оставляйте после себя чистую поляну отдельным коммитом с объяснениями. Рефакторинг и изменения поведения, в том числе и фиксы, —в разных коммитах. Ревьюер должен понимать, на что ему обратить внимание: корректность, проектирование, формат кода.
Все перечисленное выше также поможет при копании в истории системы контроля версий при расследовании багов.