본문으로 바로가기

Code Review

category software engineering/pm 2022. 8. 25. 13:34
728x90

Alignment needed on how to perform code reviews.

Code reviews are not design reviews. If you often discuss design during code reviews, there is a systemic failure somewhere in your team processes. Writing code is implementing an agreed-upon design. Therefore the design shouldn't be up for debate when reviewing the code.

Why?

  • Knowledge sharing: Making other developers more familiar with the codebase.
  • Code quality

What to review

  • Readability: Is it obvious what the code is doing?
  • Complexity: Could the code be made simpler? Would another developer be able to easily understand and use this code when they come across it in the future?
  • Naming: Did the developer choose clear names for variables, classes, methods, etc.?
  • Tests: Does the code have correct and well-designed automated tests?
  • Documentation: Did the developer also update relevant documentation?

Links

 

'software engineering > pm' 카테고리의 다른 글

회고 (Retrospective)  (0) 2022.09.01
Mono Repo vs Multi Repo  (0) 2022.08.29
Environment Variable Management  (0) 2022.08.29
IDL  (0) 2022.08.26
Miro  (0) 2022.08.25