6. Rule & Convention

(1) Git commit message convention

type: Subject

• type 종류
  • feat: 새로운 기능을 추가한 경우 사용합니다.
  • fix: 버그를 수정한 경우 사용합니다.
  • refactor: 코드 리팩토링한 경우 사용합니다.
  • style: 코드 형식, 정렬, 주석 등의 변경(동작에 영향을 주는 코드 변경 없음)한 경우 사용합니다.
  • test: 테스트 추가, 테스트 리팩토링(제품 코드 수정 없음, 테스트 코드에 관련된 모든 변경에 해당)한 경우 사용합니다.
  • docs: 문서를 수정(제품 코드 수정 없음)한 경우 사용합니다.
  • chore: 빌드 업무 수정, 패키지 매니저 설정 등 위에 해당되지 않는 모든 변경(제품 코드 수정 없음)일 경우 사용합니다.
• 참고: Udacity Git Commit Message Style Guide

(2) Code convention

• 참고: Naver Code Convention

(3) PR Rules

• PR 메시지는 다음을 따른다.
  • 제목 : [#이슈번호] 제목
  • 내용 : 왜, 무엇이 바뀌었는지 이해하기 쉽게 적는다.
• 1개의 커밋에는 1개의 행위만, 1개의 PR에는 1개의 작업만 담을 것을 권장한다.
• PR 상태를 라벨을 사용해서 표시한다.
• PR은 반드시 1명 이상의 리뷰어로부터 approved 를 받아야 merge 할 수 있다.
• merge 방식은 squash and merge 를 따른다.
• 참고 : 헤이딜러 개발 블로그