프로그래머스 데브코스에서 새로운 팀 프로젝트를 시작한다.
협업을 진행하면서 깃허브로 형상 관리를 할 예정이기 때문에 커밋과 PR의 컨벤션을 정해보려 한다.
커밋 메시지
-예시-
✨로컬 로그인 기능 추가
(생략 가능)
부연 설명
(생략 가능)
Resolves: #123
See also: #456, #789
- type
- 깃모지 사용
- 인텔리제이에서 다음 플러그인으로 커밋에 쉽게 사용할 수 있음
- 아이콘은 여기를 참고하여 작성
- subject
- 길어지지 않도록 작성
- "~ 추가", "~ 수정", "~ 리팩토링", ...
- body
- footer
- 부가적으로 issue tracker id를 작성할 때 작성
PR 규칙
- 각자의 레파지토리로 fork 후
feature/작업내용
브랜치에서 기능 개발
- 기능 개발이 끝나면 팀 레파지토리의
develop
브랜치로 PR
- PR 제목은 기능 추가의 경우 작업 단위인 유저스토리의 하위 이슈와 동일하게
- 본문에는 리뷰어들이 알아야 될 사항 명시, 연관된 이슈 있으면 링크 달아줌
- PR 작성자는 PR 후 포인트 되는 부분을 셀프 코드 리뷰로 명시(시간은 소중하다..!)
- 나머지 팀원들은 PR 발생 시 코드 리뷰
- 코드 리뷰 반영된 부분은 Resolve conversation
- 모든 리뷰 반영됐으면 Merge 하거나 추가적인 코드 리뷰가 필요하면 Re-request review