댕냥 ffㅗ짝 (2)

팀원이름

조예지

김희정

백승근

조문주

이상훈

김민경

1 more property

팀원 각자의 코드 리뷰 스타일을 적어주세요

1. 팀원 깃 레포지토리를 한눈에 볼 수 있게 링크 작성하기 2. 본인이 생각하는 코드 리뷰 핵심이 무엇인지 고민하기 3. 어떤 점을 중점으로 코드 리뷰에 임할 것인지 등을 작성해주세요!

GitLab Repository

조예지	@coastbyn	https://gitlab.com/coastbyn/FinalProject_JoYeji_team2
김희정	@hjx66	https://gitlab.com/hjx66/finalproject_kimheejung_team2
백승근	@geunnseung	https://gitlab.com/geunnseung/finalproject_seunggeun_team2
조문주	@mooonju	https://gitlab.com/mooonju/finalproject_jomunju
이상훈	@tkdtkd975	https://gitlab.com/tkdtkd975/final_project_leesanghun_team2
김민경	@minry20415	https://gitlab.com/minry20415/finalproject_kimmingyeong_team2

 리뷰의 핵심

조예지

조문주

김희정

이상훈

김민경

백승근

우리 팀의 코드 리뷰 가이드를 세워봅시다!

참고자료1) https://tech.kakao.com/2022/03/17/2022-newkrew-onboarding-codereview/ 참고자료2) https://2jinishappy.tistory.com/337 참고자료3) https://techblog.woowahan.com/2712/ 상단 자료들을 참고하여 우리 팀만의 코드 리뷰 가이드를 작성해주세요!

Check-List

변수, 클래스, 메소드 등의 이름의 의도가 명확하다.

주석으로 충분히 이해할 수 있다.

중복, 불필요한 코드나 주석, 오타가 없다.

메소드, 클래스가 독립적이며, 올바르게 사용되고 있다.

커밋 컨벤션, 자바코딩컨벤션을 준수하고 있다.

버그, 성능, 보안에 문제되지 않는다.

리뷰어의 자세

서로를 리스펙하는 마음을 가진다.

지식 공유를 목표로 한다.

사소한 의견이라도 자유롭게 의견을 제시한다.

스스로 생각할 수 있도록 피드백을 준다.

근거 또는 예시를 같이 제시한다.

사소한 칭찬도 아낌없이 한다.

상대방의 코드에 궁금한 점은 편하게 질문한다.

본인의 코드에 어려운 부분 또는 집중할 부분을 알려준다.

PR 스타일 가이드

PR 스타일

temaplate 만들기

mytemplate.md

## ❣️ Motivation
- 

<br>
## 📌 Key Changes
- 

<br>
## 👥 To Reviewers
- 
Markdown
복사

•

무슨 이유로 코드를 변경했는지

•

어떤 위험이나 장애가 발견되었는지

•

어떤 부분에 리뷰어가 집중하면 좋을지

•

관련 스크린샷

•

테스트 계획 또는 완료 사항

PR의 크기

•

너무 한번에 많이 올리면 리뷰하기가 힘들어진다. 

•

하나의 기능 구현이라도 하나의 PR에 코드량이 많아지지 않게 의미 있을 때마다 잘라서 올리기

•

의미있는 커밋 분리하기 : 중복 제거, 불필요한 코드 제거, 포맷 변경 등 의미 없는 변경은 커밋을 따로 내어주기

댕냥뽀작의 코드가이드

DTO의 사용

•

범위 

◦

controller  sevice

•

네이밍, 분기하는 기준

→ 프로젝트에 따라 다를 듯

•

Entity와의 변환 메서드 위치

◦

DTO에 넣기

프로젝트 구성

•

패키지 구조 

◦

configuration

◦

domain

▪

entity

▪

dto

•

user

•

post

•

response

◦

controller

◦

service

◦

repository

◦

security

◦

exception

◦

utils

우리 팀의 1인당 코드 리뷰 최소 시간은?

어떤 식으로 코드리뷰를 진행할 것인지 단계별로 고민하여 코드 리뷰 시간을 정해주세요!

개인 프로젝트

•

1인당 50분 (30분 코드 리뷰 댓글 작성 + 15분 말하기)

•

12/28 : 

리포지토리 하나 파서 전체를 올리고 commit에 댓글 리뷰 남기기

팀 프로젝트

•

아침 11시 : 매일 1시간

•

1인당 10분내외

•

PR이 올라오면 다음날 아침 리뷰시간 전까지 리뷰를 작성한다.

•

PR 마감 시간 : 오전 9시

코드 리뷰 완료 확인은 어떻게 진행할까요?

1. 어떤 플랫폼을 사용해서 어떻게 소통할지 2. 확인 요청 메시지는 어떻게 구성할지 3. 확인 후 코드 리팩토링은 어떻게 진행할지 등을 고민하여 작성해주세요!

GitLab 

issue 생성

template 

→ 추후 논의 후 템플릿 결정 예정

코드 리팩토링

•

3명 팀으로 리팩토링 후 확인

•

UPDATE : saveAndFlush()

◦

save()는 영속성 컨텍스트에 저장되고, saveAndFlush()는 DB에 바로 반영됨 (save() + flush())

•

@PrePersist

•

@Index(name = "post_id_idx", columnList = "post_id") // 이건 뭘까?

@Table(name = "comment", indexes = {        
		@Index(name = "post_id_idx", columnList = "post_id")
}
Java
복사

•

CommentRequest에서만 @NoArgsConstructor가 필요한 이유

◦

포스트랑 유저는 없어도 됨

•

프로젝트 가이드