HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
[팀]조규현 공간(1-2)
[팀]조규현 공간(1-2)/
🪄
코드 리뷰
코드 리뷰
🪄

코드 리뷰

💡
" 코드를 작성하는 것보다 읽는 것이 더 어렵습니다." — 조엘 스폴 스키
🚥 철학😃 리뷰 대상🙆‍♂️ 규칙리뷰어 선정리뷰 프로세스커밋 메시지 컨벤션📍 리뷰 방식 건의(?)👣 참고 링크규칙 참고 리뷰 대상 참고철학 참고리뷰 방식 참고
 

🚥 철학

코드리뷰는 단순히 버그를 사전에 발견하거나 문제점을 찾는 목적을 넘어서 전체적인 조직의 역량을 강화하는 중요한 역할을 한다. 그럼에도 코드리뷰의 가장 중요한 점 한 가지를 뽑는다면 ‘책임자를 추궁하지 않는 문화’의 정착한다.
  • 서로를 존중하며 코드리뷰 해요!

😃 리뷰 대상

이건 꼭 리뷰해요!
  1. 패키지 구조
  1. 커밋 단위와 메세지
  1. 네이밍 컨벤션
    🏪
    Intellij Java 컨벤션 및 세팅
  1. 불필요한 코드 제거
  1. 데이터 검증 / 예외처리
  1. 중복 로직
 
각자 리뷰 대상 정리

김휘년

  • 변수 & 함수 네이밍
    • +) 각 클래스의 역할에 맞는 변수 & 함수인가?
  • Commit Subject & Description
  • Optional 의 사용방법(?) (각 객체의 목적에 맞는 사용 여부?)
  • 로직 효율성, 코드 가시성
  • 다른 아이디어

이상민

  • 커밋 메시지 컨벤션
  • 커밋의 단위 (저는 이미 망했습니다)
  • 네이밍 컨벤션의 일관성
  • 검증 로직
  • 빈줄, 빈칸 일관성

강희정

  • 패키지 구조
  • 커밋 단위
  • 변수, 함수명
  • 안쓰이는 코드 (없어도 잘 동작하거나 더 효율적으로 작성할수 있는 코드)
  • 테스트코드

김은서

  • 패키지 구조
  • 네이밍
  • 버그
  • 에러 처리
  • Dto , Validation
  • 필요 없는 코드

김다희

  • 오류 처리
  • 함수 네이밍
  • 자바 스트림 깔쌈하게 사용하기
  • 디렉토리 구조
  • Dto, Vo 과 같은 네이밍을 붙이는 상황(?)

🙆‍♂️ 규칙

📌
“Any fool can make a rule And any fool will mind it.” ― Henry David Thoreau

리뷰어 선정

강의 과제 Reviewers → 1명 (무조건 해야함) - 2021-10-03(일)
  • 상민 / 휘년 서로 코드리뷰
  • 다희 / 태형 서로 코드리뷰
  • 희정 / 은서 서로 코드리뷰
notion image
  • Assignees → 멘토님 PR 을 등록 한 사람
  • Reviewers 1명 필수, 추가적으로 2명은 할 것.
게시판 과제 Reviewers → 2명 - 2021-10-19(화)
  • 상민 → 다희, 휘년
  • 다희 → 휘년, 희정
  • 휘년 → 태형, 희정
  • 희정 → 은서, 태형
  • 태형 → 은서, 상민
  • 은서 → 상민, 다희

리뷰 프로세스

  • 최소 리뷰 단위가 생길때 PR 작성
  • PR 작성자는 Reviewer 와 Assignees (작성자 본인) 를 지정한다.
    • 현재 Reviewer 가 한명만 지정되니 PR description 에 멘션을 작성해 둔다.
    • ex) @홍길동 @둘리 @멘토등장해라
    • 수정 돼서 여러명 지정 가능합니다
  • PR Description 에 자세히 작성한다.
    • 미션 중 의문이 생긴점
    • 중점적으로 봐야 하는 점
    • 리뷰어에게 알려주어야 하는 점
  • PR Description은 자주 업데이트 한다.
    • 리뷰 반영후에 Description은 수정 될 수 있다.
  • 리뷰어는 리뷰 결과를 항상 지정한다.
    • 리뷰어가 PR Approve 해주기!!
    • 혹은 PR Change requested 해주기!!
  • 제가 어느정도 마무리될 시점에 다같이 실시간 코드리뷰를 진행한다.
    • 담장자가 아니더라도 서로 공유한다.

커밋 메시지 컨벤션

  • 영어 프리픽스 : 한글
  • 목적, 대상, 행위 표현
커밋 메시지 Prefix
태그 이름
설명
Feat
새로운 기능 추가
Fix
버그 수정
Docs
문서를 수정한 경우
Style
코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
Refactor
프로덕션 코드 리팩토링
Comment
필요한 주석 추가 및 변경
Test
테스트 코드, 리팩토링 테스트 코드 추가(프로덕션 코드 변경 X)
Chore
빌드 업무 수정, 패키지 매니지 설정(프로덕션 코드 변경 X)
Rename
파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove
파일을 삭제하는 작업만 수행한 경우
// 예시 커밋 타이틀 
Feat : Person 나이 30으로 제한

// 주의해주세요!
Feat : 제한 Person 나이 30 (X)
Feat : Person 나이 30 (X)
Feat : Person 나이 30 으로 (X)
Feat : Person 나이 30으로 제한 하다. (X)
✏️
JPA 게시판 만들기 실시간 코드 리뷰

📍 리뷰 방식 건의(?)

  • 매운 맛이더라도 최대한 기분 상하지 않게 코멘트를 남긴다.
  • 리뷰에 해당하는 부분에 대해 자세히 가리킨다.
    • 캡쳐 이미지 활용
    • 링크 활용
    • Commit Id 활용
    • 코드 라인
    • 코드 블럭 예시
  • 이모지를 많이 활용한다.
  • 의문이 생기는 부분이 있다면 PR 이외에서 스크럼 시간에도 같이 예기한다.
 

👣 참고 링크

규칙 참고

techblog.woowahan.com
https://techblog.woowahan.com/2712/
 

리뷰 대상 참고

코드리뷰의 진짜 목적은 따로있다
코드리뷰란, 한 명 또는 여러 명의 개발자가 본인이 만들지 않은 코드의 내용을 점검(examining)하고, 피드백을 주는 과정을 말합니다. 여기에서 피드백이란 오타, 버그 가능 성, 개발 표준 등에 대한 의견이 될 수도 있고, 좋은 코드에 대한 긍정적인 피드백이 될 수도 있습니다.
코드리뷰의 진짜 목적은 따로있다
https://blog.logi-spot.com/%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0%EC%9D%98-%EC%A7%84%EC%A7%9C-%EB%AA%A9%EC%A0%81%EC%9D%80-%EB%94%B0%EB%A1%9C%EC%9E%88%EB%8B%A4/
코드리뷰의 진짜 목적은 따로있다
 

철학 참고

코드 리뷰 | TechWell
코드리뷰란, 한 명 또는 여러 명의 개발자가 본인이 만들지 않은 코드의 내용을 점검(examining)하고, 피드백을 주는 과정을 말한다. 여기에서 피드백이란 오타, 버그 가능 성, 개발 표준 등에 대한 의견이 될 수도 있고, 좋은 코드에 대한 긍정적인 피드백이 될 수도 있습니다.
코드 리뷰 | TechWell
https://techwell.wooritech.com/blog/2021/04/19/%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0/
코드 리뷰 | TechWell
구글의 코드 리뷰 가이드: 코드 리뷰의 표준 원칙
코드 리뷰의 주요 목적은 구글의 코드 베이스의 전반적인 코드 품질을 시간이 지남에 따라 개선되고 있는지 확인하는 것입니다. 코드 리뷰의 모든 도구와 프로세스는 이를 위해 설계되었고 이를 달성하기 위해서는 작성자와 리뷰어의 일련의 균형이 맞춰져야 합니다. 먼저, 개발자는 자신의 일을 진행할 수 있어야 합니다. 당신이 코드를 개선시키지 않으면 코드는 절대로 나아지지 않습니다.
구글의 코드 리뷰 가이드: 코드 리뷰의 표준 원칙
https://madplay.github.io/post/the-standard-of-code-review
구글의 코드 리뷰 가이드: 코드 리뷰의 표준 원칙
 

리뷰 방식 참고

코드 리뷰 in 뱅크샐러드 개발 문화 | 뱅크샐러드
안녕하세요, 뱅크샐러드 BanksaladX iOS Engineer 정진규입니다. 코드 리뷰란 개발자가 작성한 코드를 다른 사람들이 검토하고 피드백을 전달하며, 다시 작성자가 반영하는 과정을 말합니다. 이 과정을 통해 서비스의 기술적인 구현 부분에 대해 공유·습득할 수 있으며, 일관된 아키텍처를 유지하고, 문제를 해결할 수 있는 새로운 관점을 발견할 수도 있습니다.
코드 리뷰 in 뱅크샐러드 개발 문화 | 뱅크샐러드
https://blog.banksalad.com/tech/banksalad-code-review-culture/
코드 리뷰 in 뱅크샐러드 개발 문화 | 뱅크샐러드
수용력 있는 코드 리뷰 문화 만들기
이 글은 Building an Inclusive Code Review Culture를 번역한 글입니다. 모든 개발자는 코드 리뷰에 익숙합니다. 그리고 우리 이전의 많은 사람이 그것을 어떻게 할지에 대한 생각과 제안들을 쌓아왔습니다. 코드 리뷰는 모든 개발자가 매일 매일 수행하는 필수적인 요소기 때문에 팀 문화에 큰 영향을 미칩니다. Plaid에서, 우리는 수용력 있고 상호협력적인 문화에 자부심을 가지고
수용력 있는 코드 리뷰 문화 만들기
https://blog.koriel.kr/building-an-inclusive-code-review-culture/
수용력 있는 코드 리뷰 문화 만들기