팀원 각자의 코드 리뷰 스타일을 적어주세요 
가준영
클래스, 메소드, 변수명 등에 대한 네이밍과 같은 코드 컨벤션을 집중해서 봅니다.
또한, 각 메소드 위에 Javadoc을 추가하는 것을 선호합니다!
김동현
코드 리뷰를 할 때 구현 방식을 주로 많이 살펴보곤 합니다. 왜 그런 방식으로 구현했는지 만약 제가 알고 있는 다른 방식과 비교가 가능하다면, 어떠한 방식이 더 좋은 방식인지 확인하는 형식으로 많이 리뷰를 해왔습니다~! (그렇게 생각하는 이유를 꼭 달아 두려고 합니다~)
도석영
중복은 줄이고 네이밍을 통일하려고 노력합니다. 그리고 특정 분기가 되는 조건문 같은 부분은 어떤 경우인지 주석으로 남겨서 가독성을 높이려고 합니다. 코드 리뷰 경험이 적지만 배워가면서 열심히 따라가겠습니다.
우민식
제가 구현한 부분과 어떤 부분에서 다른지 확인하여 같은 기능을 어떻게 짜셨는 지 비교하고 다양한 방법을 볼 수 있도록 리뷰하겠습니다.
조아영
아직은 부족한 부분이 많아서 배우고자 하는 자세! 로 구현 해주신 부분을 하나씩 직접 실행해보며 생기게 된 궁금증을 위주로 작성하는 편입니다.
ex) 저는 ~~ 방법을 사용했는데 어떤 이점 때문에 ~~ 방식을 사용하셨나요?
무조건 짧기만한 코드 보다는 가독성이 있는 것을 선호해서 코드를 한 번 훑어봤을 때 작동 과정이 머릿속에서 잘 그려지는 지를 생각합니다.
전병찬
불필요한 코드는 없는지 , 간결하게 표현이 가능한 코드인지(이해가 필요한 코드는 간결하게 하지 않으려고 합니다.) , 주로 칭찬이 섞인 리뷰를 많이 합니다.
박종수
내가 작성한 코드를 중심으로 타인의 코드와 비교하여 타인의 코드의 장점과 단점을 파악, 궁금한 점이 발생하면 질문하고, 느낀 점을 바탕으로 자기성찰
신상원
가독성을 중요하게 생각합니다. 변수, 메소드명 등이 적절하게 작성 되었는지, 이름을 적절하게 작성하여 주석이 필요없는데 주석을 작성하였는지, 혹은 설명이 필요한 부분에서 주석이 작성되지 않았는지 등을 주로 살펴봅니다.
위와 관련하여, 개인 프로젝트니 만큼 본인의 코드 컨벤션이 지켜지고 있는지도 주로 살펴봅니다.
구현과 관련해서는 제 실력이 아직 부족하기도 하고, 구현 방식에 정답이 없고 사람마다 구현 방식이 다르다고 생각하기 때문에 깊게 리뷰하지는 않지만, 개인적으로 궁금한 부분이나 저의 구현 방식과 비교하여 새로운 부분에 대해서는 각자의 구현 방식에 대해 의견 나누는 것을 좋아합니다.
우리 팀의 코드 리뷰 가이드를 세워봅시다!
: Commit은 기능 구현마다 한 번씩 나누어서 진행하기!
: 정답 코드 대신 참고 자료 올려주기!
: 명령조가 아닌 의견 제시형으로 리뷰하기!
: 코드 컨벤션 고려하여 리뷰하기!
: 자신의 코드와 비교하여 리뷰하기!
: 누구나 봐도 이해하기 쉬운 클린코드 리뷰하기!Commit은 기능 구현마다 한 번씩 나눠서 진행하기!Commit Message Convention
•
“type #issueNum : message"의 형태로 작성!
Type 확인
ex) git commit -m "feat #1 : 회원가입 기능 추가"
Java
복사
정답 코드 대신 참고 자료 올려주기! 답을 알려주기보다는 스스로 고민하고 개선 방법을 선택할 수 있도록 참고 자료를 올려주세요! 답을 따라 하는 코드보다 스스로 고민하여 구현한 로직은 더 많은 애정이 생기고, 능동적인 개발자로 성장할 수 있는 중요한 덕목입니다~
명령조가 아닌 의견 제시형으로 리뷰하기! 다양한 사람들이 모여 리뷰하는 Final Project인 만큼 서로에게 유익한 리뷰를 남겨야 합니다! 직설적인 말투는 상대방이 불편하게 받아들일 수 있습니다. 명령하는 듯한 말투 보다는 의견을 제시하는 리뷰를 지향하면서, 리뷰합니다!
코드 컨벤션 고려하여 리뷰하기 클래스, 메소드, 변수명 등 네이밍에 있어서, 자료구조나 의도가 무엇인지 명확히 알기 위해 적절한 단어 선택이 중요하다. 그러나 네이밍으로 의도를 전달하기 제한적인 부분일 때, JavaDoc를 통해서 적절한 설명을 덧붙여 의도를 전달하는 부분을 고려하여 리뷰해보자!
안좋은 예시
const data = [
['데이터베이스', 'A', 3],
['교양영어', 'B+', 1],
['철학', 'A', 2]
];
적절한 예시
const grade= [
['데이터베이스', 'A', 3],
['교양영어', 'B+', 1],
['철학', 'A', 2]
];
JavaScript
복사
자신의 코드와 비교하여 리뷰하기! 자신과 다른 팀원의 코드를 비교해 보면서 자신이 생각지 못한 방식을 새롭게 찾아볼 기회가 될 수 있습니다. 더 나아가 “왜 이러한 방식을 사용했을까?”라는 의문을 던져보면서, 하나의 목표에도 여러 방식으로 구현하는 법을 배워보며 리뷰해보자!
누구나 봐도 이해하기 쉬운 클린코드 리뷰하기! 나만 알아볼 수 있는 코드는 비효율적인 코드가 될 가능성이 큽니다. 다양한 사람이 나의 코드를 봐도 이해하기 쉽도록 클린 코드를 잘 작성하였는지 팀원의 코드를 확인해 봅시다!
불필요한 코드는 없는지, 가독성이 좋게 코드를 리팩토링 할 수 있는지, 더욱 간결하게 코드를 표현할 수 있는지 다양한 클린코드를 고려하여 리뷰합니다~
우리 팀의 1인당 코드 리뷰 최소 시간은?
20 ~ 30분 정도 팀원의 코드를 살펴본다. 10 ~ 20분 정도 리뷰를 작성한다. (필요한 참고 자료는 많은 수록 )코드 리뷰 완료 확인은 어떻게 진행할까요?
Notion을 활용하여 체크 진행 2) 리뷰하고 싶은 사람의 페이지를 클릭한다.
3) 각 GitHub Repository에서 Issue를 통해 코드 리뷰를 남긴다.
4) 리뷰가 끝났으면, 자신의 이름에 체크를 한다.
5) 체크된 리뷰를 살펴보며 답글 or 코드 리펙토링을 준비한다.
