Git 컨벤션 / PR

제목 (Subject)

• 제목과 본문을 한 줄 띄우고 콜론(:) 으로 분리.
• 영문 기준 동사(원형)을 가장 앞에. (과거 시제를 사용하지 않음.)
• 제목 끝에 . 는 생략
• 제목은 명령어, 개조식으로 작성.

• 예시

제목 태그 이름	설명
Feat	새로운 기능 추가
Fix	버그 고친 경우
Design	CSS 및 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경
!HOTFIX	급하게 치명적인 버그 고쳐야 하는 경우
Style	코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는 경우
Refactor	코드 리팩토링
Comment	주석 추가 및 변경
Docs	문서 수정
Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore	빌드 테스트 업데이트, 패키지 매니저 설정(프로덕션 코드 변경 X)
Rename	파일 및 폴더명 수정 또는 디렉토리 이동 작업
Remove	파일 삭제

본문(body)

• 선택사항
• 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성.

꼬리말(footer)

• 선택사항
• issue tracker id를 작성할 때 사용.
• 유형: #이슈 번호 형식으로 작성.
• 유형은 다음 중 하나를 사용.

• 유형 예시

이슈 트래커 유형	설명
Fixes	이슈 수정 중(아직 해결 중)
Resolves	이슈 해결 완료
Ref	참고할 이슈 있을 때 사용
Related	해당 커밋에 관련된 이슈 번호(아직 해결 중)

Pull request 작성하기

• PR 형식

  • 코드 컨벤션 잘 지키기.
  • 리뷰 가이드라인 잘 작성하기. 코드가 변경되었다면 나만 알고 있지 말고 사소한 거라도 한 줄이라도 적어놓기.
  • 작업중[WiP] (Work in Progress), 리뷰 가능 여부(review-needed) 잘 명시하기.

• 변수 이름 Camel-case : clientLogin

• 파일 & 생성자 이름 Pascal-case : ClientLogin