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

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

Overview

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

타입: 설명 (#이슈번호)

- 추가 설명
- 추가 설명

• 타입: 커밋의 성격을 나타내는 부분으로, 주로 다음 중 하나를 사용해요

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • docs: 문서 변경
  • style: 코드 스타일 변경(공백, 서식 등)
  • refactor: 코드 리팩토링
  • test: 테스트 코드 추가 또는 수정
  • chore: 빌드 프로세스나 도구 설정 변경

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

• 설명: 해당 커밋을 보고 리뷰할 팀원들을 위해 명확하고 간결하게 부탁해요! (불필요하다면 생략해도 돼요)

  예시)
  feat(member): 사용자 인증 기능 추가 
  fix: 로그인 버그 수정 (#123)
  docs: 프로젝트 README 업데이트 (#123)
  style: 코드 포맷팅 조정 (#123)
  refactor: API 코드 리팩토링 (#123)
  test: 로그인 테스트 추가 (#123)
  chore: 빌드 스크립트 업데이트 (#123)
  

주의사항

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

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

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

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