좋은 코드 리뷰란?

준프 · June 19, 2023 11:56am

좋은 코드 리뷰란?

좋은 코드 리뷰 또는 문화란 어떤 걸까요? 코드리뷰를 매일 하고 있지만 항상 어려운 것 같습니다. 관련된 문화가 잘 잡혀있다면 다행이지만, 그렇지 않다면 어떻게 코드리뷰를 주고 받아야 할지 정하는 과정이 생각보다 쉽지 않다는 걸 알게 됩니다. 왜냐하면 어떤 방법이 더 좋은지, 어떻게 해야할지, 우리는 어떤 성향을 가진 구성원이고 조직인지 너무 모호한 질문들이 많기 때문입니다. 이럴 땐 시도해보고 돌아보고 개선하는 과정을 필연적으로 경험할 수 밖에 없는 것 같습니다.

그래서 오늘은 코드리뷰와 관련된 아티클을 몇 개 가져와봤습니다. 그리고 제게 도움이 됐던 몇 가지를 요약하려고 합니다. 시간이 되신다면 하나하나 읽어보는 것도 추천드립니다 ! 그리고 여러분의 의견, 봤던 좋은 아티클들을 소개해주시면 좋을거 같아요 :)

가장 먼저 떠오르는 건 Pn 문화 입니다. 반영해야 하는 우선순위에 따라 P1 부터 P5까지 있습니다. 만약 반드시 반영해야 하는 이슈가 있다면 P1을, 단순한 의견을 전달하는 거라면 P5를 리뷰 앞에 달아줍니다.

리뷰를 할 때면 내 피드백의 중요성에 대해 또는 상대 피드백의 중요성에 대해 언급하는 게 큰 비용처럼 느껴질 때가 있는데 이 방법이 그런 비용을 줄여줍니다.

그 밖에도 리뷰 요청 코드의 라인수(LoC), 설명엔 어떤 걸 적어야 하는지, 리뷰 우선순위 등 좋은 정보를 많이 담고 있습니다.

코드 리뷰 in 뱅크샐러드 개발 문화 | 뱅크샐러드

안녕하세요, 뱅크샐러드 BanksaladX iOS Engineer…

https://blog.banksalad.com/tech/banksalad-code-review-culture/

아래 글에서도 이상적인 PR의 라인수(250라인 이하)와 '하나의 PR은 한 가지 문제를 해결한다' 등과 같은 원칙들을 소개합니다. 특히 PR 템플릿을 소개하는 점이 좋았습니다. 과한 측면이 없지 않아 있지만 그렇기에 더 좋았습니다. 왜냐하면 구성원과 조직의 상황에 맞게 참고할 수 있기 때문입니다.

그리고 리뷰어를 위한 체크리스트가 있고, 이 리스트는 특정 PR이 아니라 모든 PR에서 지켜야 하는 체크리스트를 담고 있어서 참고할만 했습니다.

Building a scalable PR review process.

Motivation and Background

https://medium.com/@Games24x7Tech/building-a-scalable-pr-review-process-b0c8ef8dbea0

그리고 아래 글은 다양한 통계와 요약을 담고 있어서 좋다고 생각합니다. 종종 참고합니다.

Pull requestの理想的なサイズとその理由

https://zenn.dev/isana/articles/ideal-size-of-pull-request-and-why

마지막으로 소개해드리는 글은 좋은 코드 리뷰 문화를 갖고 있는지 측정하는 방법들을 소개합니다. 이 글이 특히 좋은 이유는 측정 방법을 소개하는 과정에서 많은 인사이트를 얻을 수 있기 때문입니다. 그리고 이 글의 시작 부분이 인상적입니다.

Just as we track bugs & rate complexity in our CI, or produce Wealth Analytics for our clients to help answer questions about risk, scenarios, or cash flows, we can do the same to track several indicators about our PR culture.

목차를 간략하게 소개해드리면