코드 리뷰에 참고가 될만한 글이 있어 첨부한다.
원문 : https://letterstoanewdeveloper.com/2021/01/25/how-to-criticize-code/
How to criticize code
Dear new developer, Criticizing code (and software solutions in general) is an important skill. It helps transmit norms, increase team knowledge, and improve solutions. But it isn’t something…
letterstoanewdeveloper.com
첫째, 맥락(컨텍스트)를 이해한다. 두가지 타입의 맥락이 있는데, 그 중 하나가 비지니스 맥락이다.
이 시스템이 문제를 어떻게 해결하려하는가, 이 비지니스가 가진 제한사항(시간, 돈, 노동력, 이해 등)은 무엇인가?
때론 완벽한 아키텍셔나 유지보수성보다 모험적인 코드들이 상황에 따라 가치있을 수 있다.
기술적인 맥락을 이해하는 것 또한 중요하다. 팀 지식의 규모, 수준, 기간은 어떠한가? 모든 정보가 비평에 녹아있어야 한다.
이러한 컨텍스트들은 시간이 지남에 따라 변하므로, 오래된 추정을 갖고 있지 않은지 더블체크가 필요하다. 팀 리더와 빠른 대화를 통해 파악하는 것도 도움이 될 것이며, 같은 컨텍스트를 유지할 수 있도록 팀 전체가 정기적인 모임을 갖는 것도 방법이 될 수 있다.
우리의 리뷰나 비평의 목적은 실행가능한 피드백을 통해 우리와 작성자의 코드를 향상하고 시스템을 이해하는 것이다.
과한 피드백은 오히려 작성자에게 무리를 줄 수 있다.
작은 것에 집중하지 말자. 린터로 해결할 수 있는 문제라면, 린터로 해결하자.
'톤' 에 주의하자. 그 사람이 어떤지에 대한 것을 그 사람의 구현과 섞어보지 말자.
'개발공부 > 주저리' 카테고리의 다른 글
K8S 컨테이너 런타임에 대한 잡지식 (1) | 2024.09.12 |
---|---|
모름을 모른다는 것 (1) | 2024.04.10 |
Enter passpharase for key: 매번 입력하지 않도록 설정하기 (0) | 2024.04.07 |
Kotlin 이더라도 CheckedException, UnCheckedException 정의를 주의할 것 (0) | 2021.10.17 |
RSA 복호 캡슐화 아이디어 (0) | 2021.08.18 |