저희 프로젝트에서는 Pull Request를 기준으로 커밋을 남기고 최종 작업물을 merge 해요

프로젝트에서는 명확하고 일관된 커밋 메시지를 유지하도록 할게요

각 커밋은 코드 이해와 변경 이력을 추적하는 데 도움이 되어야 해요!

Overview

커밋 메시지 구조는 최대한 간단하게 다음처럼 구성 할게요

## 커밋 메시지
Jira 이슈번호 커밋 사항 설명 (#PR번호)

• 이슈 번호: 추적관리를 위해 PR번호를 넣어주세요.

  브랜치 처음 커밋시 PR번호는 불필요하나, 최종 merge 시 커밋 메세지는 위의 컨벤션을 지켜주세요

• 설명: 해당 커밋을 보고 리뷰할 팀원들을 위해 명확하고 간결하게 부탁해요!

• 예시

  • S14P11B104-05 Table 생성 및 문서관리 (#13)

예를 들어, [S14P11B104-05] 이미지 업로드 기능 추가 #27 PR 후 해당 작업물에 대해 merge 하기 전 변경사항이 있다면 S14P11B104-05 이미지 업로드 함수 로직 변경 (#27) 과 같이 커밋 메세지를 남겨요

주의사항

• 한 커밋에 서로 다른 변경사항들을 2개 이상 넣게 되면 커밋을 분할해서 올리는 의미가 없어지는 것 같았어요. 가독성이 떨어지고 추적 관리에도 어려워요.

• 변경된 파일이 많다면 최대한 이해가 쉬운 단위로 커밋을 나누어 작성해줬으면 해요!

  (예를 들자면 디렉토리 이동, 네이밍 변경의 경우 따로 하나의 커밋으로 두기)

커밋과 관련해서도 👀코드 리뷰에서 서로 의견👀을 남겨주면 좋을 것 같아요!