나도 코드 리뷰 좀 해보자!

안녕하세요. 방구석 개발자 입니다.

우리회사는 코드리뷰 문화가 없어요...😂  그렇지만 저는 코드리뷰를 하고 싶었어요. 그래서 https://shinsunyoung.tistory.com/92 포스팅 글을 보고 용기내어 동료개발자에게 코드 리뷰를 해보자고 했습니다.

다행스럽게 흔쾌히 같이 하자고 하여 이번 프로젝트에서  코드리뷰를 시도 해보았어요.👍

현재 프로젝트는 폐쇄망 + SVN 을 사용했기 때문에 git처럼 댓글형식으로 리뷰를 하진 못하였고 엑셀을 이용하여 진행했어요.

무엇을 얻었을까?

좋았던 점

지켜본다는 생각에 코드를 가독성 좋게 누군가 읽기 쉽게 짜려고 노력하게 되었어요.

제가 놓친 부분들을 짚어주워서 에러를 방지 할 수도 있었어요.

궁금한 점들을 쉽게 물어보고 또한 질문 받은 것들을 다시 정리 하여 알려주여 개발역량 강화에 도움이 되었어요.

코드 컨벤션, 커밋 컨벤션을 지키려고 노력하니 자연스럽게 컨벤션 문화에 익숙해 질 수 있었어요.

리뷰 글이나 답글에 최대하 이해하기 쉽게 설명하려고 노력하게 되었어요.

아쉬웠던 점

git이 아니기 때문에 리뷰를 해달라고 요청을 메세지나 구두로 했어요.

엑셀로 코드 리뷰를 했기 때문에 피드백 답글을 보기 어려웠어요.

얕은 지식으로 코드를 보았기에 더 깊은 리뷰나 피드백을 하지 못한게 아쉬웠어요.

어떻게 적용했을까?

1. 자바 컨벤션 정하기

인터넷에 나와있는 기본적인 자바 코드 컨벤션을 지키기로 하였어요.(그렇지만 가끔은 지켜지지 못했다는게 함정)

2.커밋 컨벤션 정하기.

아래와 같이 커밋 컨벤션을 정하고 목적에 맞게 커밋 코멘트를 작성하였어요.

Message Structure
메시지는 아래와 같이 제목/본문/꼬리말로 구성합니다.

type : Subject
body
footer

Type
feat : 새로운 기능 추가 또는 요구사항 변경으로 기능 추가fix : 버그 수정style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우, 필요한 주석 추가 및 변경refactor : 코드 리펙토링test : 테스트코드, 리펙토링 테스트코드 추가chore : 빌드 수정, 패키지 수정, 프로젝트 구조 변경, 라이브러리 수정

Subject
제목은 50자를 넘기지 않고, 문장의 끝에 특수문자(마침표 포함)를 넣지 않습니다.커밋 메시지에는 과거시제를 사용하지 않고, 명령어로 작성하도록 합니다.

body
메뉴 네비게이션을 본문 제일 앞에 적어줍니다.본문 내용은 시스템 메뉴를 제외하고 선택사항입니다.어떻게 변경했는지 무엇을 변경했는지 왜 변경했는지를 설명합니다.또한 추가적으로 정보를 전달하고 싶을 경우 본문에 기입하시면 됩니다.

footer
꼬리말도 본문과 같이 선택 사항입니다.이슈 ID, 고려사항, 참고사항을 넣어주는 용도로 사용합니다.

example
feat : 메뉴 관리 등록 기능
메뉴 관리 > 목록화면 > 등록버튼Controller Service Dao Vo 파일을 추가 하였습니다.테이블 컬럼이 2개 추가되어서 그에 맞게 등록 기능을 변경하였습니다.
등록 기능 속도가 5초이상 걸려 개선이 필요해 보입니다.

3. 엑셀에 svn history를 넣고 리뷰 하기

공유하는 엑셀 파일을 만들어서 svn history를 넣고 리뷰를 했어요.

물어보는 것들이 있으면 옆에 답글로 남겼습니다.

계속 궁금한 점이 있으면 옆으로 계속 답글을 달면 됩니다.

author에는 커밋한 사람 이름을 적었습니다.(포스팅을 위해 잠시 지웠습니다.)

코드 리뷰를 해준사람이 피드백을 충분히 받으면 Done에 V표시로 해당 커밋의 리뷰를 마쳤습니다.

코드 리뷰 엑셀

앞으로는?

작게남아 코드 리뷰를 해서 얻어 가는게 많다고 느꼈어요.

굉장히 긍정적이어서 계속 하고 싶었으나 동료개발자께서 좋은 곳으로 이직하셨기에 지금은 리뷰를 하지 못하고 있습니다.. ㅜㅜ

이번 경험을 바탕으로 같이 일하는 개발자분들에게 코드 리뷰를 하자고 계속 이야기 해 볼 생각입니다.

감사합니다.