.png&blockId=18f00b21-a9bc-4e35-aeb8-ecb07bddb89a)
팀원 각자의 코드 리뷰 스타일을 적어주세요 
1. 팀원 깃 레포지토리를 한눈에 볼 수 있게 링크 작성하기
2. 본인이 생각하는 코드 리뷰 핵심이 무엇인지 고민하기
3. 어떤 점을 중점으로 코드 리뷰에 임할 것인지 등을 작성해주세요!
GitLab Repository
이름 | GitLab Id | GitLab Repository |
김민지 | minjikim99 | |
박정훈 | pi22a555 | |
변흥섭 | seop93 | |
곽철민 | cmkxak | |
이도현 | dohyunre702 | |
조국현 |
코드 리뷰 핵심
김민지
박정훈
변흥섭
곽철민
이도현
조국현
우리 팀의 코드 리뷰 가이드를 세워봅시다!
참고자료1) https://tech.kakao.com/2022/03/17/2022-newkrew-onboarding-codereview/
참고자료2) https://2jinishappy.tistory.com/337
참고자료3) https://techblog.woowahan.com/2712/
상단 자료들을 참고하여 우리 팀만의 코드 리뷰 가이드를 작성해주세요!
리뷰가이드
피어리뷰 필수항목
•
가장 이슈가 되는 부분 (기능 구현에 대한 부분) 언급
•
코드 상 이해하지 못한 부분, 문제가 되는 부분을 구체적으로 언급
•
보완해야할 부분에 대한 의견 제시
•
총평
1.
왜 개선이 필요한지 이유를 설명해주기
2.
답보다는 개선 방법을 선택할 수 있도록 리뷰하기
3.
리뷰를 위한 리뷰 하지 않기
4.
비즈니스 로직 모르는거 물어보기
리뷰요청 가이드
1.
무슨 이유로 코드를 변경했는지
2.
어떤 부분에 리뷰어가 집중하면 좋을지
3.
작업 상세 내용 작성하기
4.
기능을 너무 큰 단위로 나누지 않기
우리 팀의 1인당 코드 리뷰 최소 시간은?
어떤 식으로 코드리뷰를 진행할 것인지 단계별로 고민하여 코드 리뷰 시간을 정해주세요!
개인 프로젝트 : 40분 이상
팀 프로젝트 : 15분 이상
코드 리뷰 완료 확인은 어떻게 진행할까요?
1. 어떤 플랫폼을 사용해서 어떻게 소통할지
2. 확인 요청 메시지는 어떻게 구성할지
3. 확인 후 코드 리팩토링은 어떻게 진행할지 등을 고민하여 작성해주세요!
플랫폼
GitLab
기능별로 이슈와 브랜치 생성 후 Merge Request 작성(두번째 미션부터 진행)
첫번째 미션
요청 메시지
Readme.md
<!-- 제목 커밋컨벤션 -->
## 설명(간단하게)
### 작업 내용(자세히)
### 스크린샷(선택)
### 주안점
<!-- 리뷰어가 확인해줬으면 하는 부분 -->
### 체크리스트
- [ ] 구현한 로직상에서 오류가 날 수 있는 부분은 없는지
- [ ] 변수, 클래스, 메소드 등에 명확한 이름을 선택했는지
- [ ] 주석이 명확하고 유용한지
- [ ] 주석이 없어도 네이밍이 명확한데 필요 없는 주석이 있는지
- [ ] 코드가 필요 이상으로 복잡하지 않은지
- [ ] 스타일 가이드를 잘 지켰는지 (이 부분은 팀 내의 코딩 컨벤션을 따릅니다.)
- [ ] 무엇을 변경했는지 충분히 설명했는지
- [ ] 새로운 기술을 사용했다면, 그 기술을 설명했는지
- [ ] 이해하기 어려운 비즈니스 로직에 관해서 부연 설명했는지
- [ ] 테스트코드를 작성했는지
### 개선하고 싶은 부분
Markdown
복사
규칙
커밋컨벤션
양식
Tag : Title
Body
Plain Text
복사
Type
태그 이름 | 설명 |
Add | 새로운 기능 추가 구현한 경우 |
Fix | 버그를 고친 경우 |
Update | 버그가 아닌 코드 수정 |
Test | 테스트 추가, 테스트 리팩토링 |
Refactor | 프로덕션 코드 리팩토링 |
Design | CSS 등 사용자 UI 디자인 변경 |
Docs | 문서를 수정한 경우(README.md) |
Rename | 파일 혹은 폴더명을 수정하거나 옮기는 작업을 한 경우 |
Remove | 파일을 삭재하는 작업만 수행한 경우 |
Comment | 필요한 주석 추가 및 변경 |
