팀원 각자의 코드 리뷰 스타일을 적어주세요 
김동민, 김성현, 김예진, 서창민, 이주원1, 임채민, 장동익, 정영환, 현지혜
코드 리뷰 스타일
•
1조의 코드 리뷰 스타일은 전원 공유 git 리포지터리를 통해 Pull Request Comment를 날리는 형식으로 리뷰를 진행하기로 하였습니다.
팀 공유 리포지터리
전체적인 과정은 아래와 같습니다.
월 ~ 수
개인 리포지터리에 프로젝트 코드와 record를 작성하여 올린다.
목
1.
공유 리포지터리의 개인별 “working branch” (ex scm_working) 에서 개인 프로젝트 전체를 올린다.
2.
본인의 working branch에서 Pr을 요청한다. (ex scm_woring → scm)
ex)
[1week] SCM : 구현 내용
## Done
- A 기능 구현
- B 기능 구현
## Todo
- C 코드 리펙토링 예정
Markdown
복사
3.
10시부터 본인을 제외한 팀원의 Pull Request에 Comment 형식으로 코드 리뷰를 작성한다.
## [김멋사] Peer Review
- 좋은 점
- A가 좋았습니다.
- B가 좋았습니다.
- C가 좋았습니다.
- 의견제시
- D로 하시면 더 좋을 거 같습니다.
- 찾아보니 E라는 방법도 있었습니다.(링크 제시)
Markdown
복사
코드 리뷰의 폼 작성 템플릿을 기초하여 작성하되, 코드를 끌어와서 자유롭게 작성하여도 됩니다.
4.
코드 리뷰가 완료된 후 본인의 브랜치로 merge 한다.
참고 예시)
개인별 리포지터리 가이드
공용 리포지터리에 개인별 branch를 생성 가이드
개인별 branch 이니셜, 이니셜_working 두개 생성
•
merge를 위한 브랜치와 ex) scm
•
코드를 올리는 woring 브랜치 ex) scm_working
ex) 목요일 Pr 작성 시 상황
scm : change 없음
scm_working : 이번주 코드가 올라가 있음
ex) 목요일 코드 리뷰 완료 후 상황
scm : scm_woring이 머지 됨
scm_woring : scm에 머지
Markdown
복사
우리 팀의 코드 리뷰 가이드를 세워봅시다!
코드 리뷰 가이드 (공통으로 포함되어야 할 내용)
•
레퍼런스에 대한 링크를 첨부해주시면 좋습니다.
•
좋은점 1가지 이상
•
피드백 점 1가지 이상
•
마크다운 양식 통일 (템플릿)
•
예시
피어 리뷰 코멘트 템플릿
## [김멋사] Peer Review
- 좋은 점
- A가 좋았습니다.
- B가 좋았습니다.
- C가 좋았습니다.
- 의견제시
- D로 하시면 더 좋을 거 같습니다.
- 찾아보니 E라는 방법도 있었습니다.(링크 제시)
Markdown
복사
피어리뷰 필수 항목
피어리뷰 시 먼저 팀 내에서 자율적으로 리뷰 규칙을 정하시는 것을 권장드립니다
•
가장 이슈가 되는 부분 (기능 구현에 대한 부분) 언급
•
코드 상 이해하지 못한 부분, 문제가 되는 부분을 구체적으로 언급
•
보완해야할 부분에 대한 의견 제시
•
총평
피어리뷰 Check List
구현한 로직상에서 오류가 날 수 있는 부분은 없는지
변수, 클래스, 메소드 등에 명확한 이름을 선택했는지
주석이 명확하고 유용한지
주석이 없어도 네이밍이 명확한데 필요 없는 주석이 있는지
코드가 필요 이상으로 복잡하지 않은지
스타일 가이드를 잘 지켰는지 (이 부분은 팀 내의 코딩 컨벤션을 따릅니다.)
우리 팀의 1인당 코드 리뷰 최소 시간은?
리뷰 완료하는 마감 시간 < 목요일 : 10시 ~ 18시까지 >
1명 당 8명을 리뷰해야 되기 때문에 1명씩 30분~1시간 정도 총 8시간
코드 리뷰 완료 확인은 어떻게 진행할까요?
디스코드에 남기는 형식으로 코드 리뷰 완료를 확인합니다.
디스코드 채널에 리뷰 완료 후, 목요일 18시 이전까지 멘션 포함 메시지 공유
OO님, OO님 코드 리뷰 완료하였습니다. 확인 부탁드립니다!
Markdown
복사
