Commit Convention
PR Convention
원칙
- 원격 저장소에 PR을 올리기 전에
- 컴파일 오류가 없음을 보장
- 최신 develop 브랜치의 소스 위에서 수정이 진행되었는지 점검. 그러지 않았다면 최신 develop 소스를 풀 받고, 컨플릭트가 났을 경우 해결해서 PR
- develop을 직접 수정하면 안 됩니다. develop 브랜치 위에 커밋 X. 반드시 feature 또는 Issue 브랜치를 만들어 그 위에 작업해야합니다.
- 불필요한 주석과 console.log가 없는지 확인합니다.
- PR을 작성할 때는 커밋 내역을 내용으로 첨부하고, 이외에 팀원들에게 자신의 소스 수정에 대해 알릴 사항, 혹은 작업 내역을 보여줄 수 있는 이미지를 첨부합니다.
- 컨플릭트도 본인이 해결해서 컨플릭트를 리졸브하는 커밋을 하고 컴플릿합니다.
- 코드리뷰는 n시간 안에 작성합니다?
- 긴급: 3시간 이내
- 보통: 24시간 이내
- 천천히: 72시간 이내
- 리뷰에 대한 응답은 24시간 안에 작성합니다?
MERGE
- 본인이 올린 PR은 본인이 MERGE. 이는 코드리뷰로 진행된 피드백을 확인하고, 반영할지 혹은 그렇지 않을지 본인이 선택할 수 있는 여지를 남기기 위해서입니다.
- 다른 3명의 팀원 중 1명 이상이
approve하였을 경우에만 merge합니다.
on Review
- 코드리뷰로 달린 모든 코멘트를 확인할 것
active에서resolved로 바꾸는 것도 PR을 올린 사람의 몫.
- 피드백을 수용한다면 수정 후
resolved로, 피드백을 수용하지 않는다면 추가 코멘트를 달고closed.
Review Convention
원칙
- PR 내역에 대하여, ‘이 코드는 틀려먹었다’라는 마인드로 접근할 것. 컨트리뷰터와 리뷰어는 공동 책임자이다.
- 모든 CL(Change List)를 컴토할 것.
- 컨트리뷰터는 리뷰어에게 CL에 대한 정보를 충분하게 제공할 것.