📄 [문서] 커밋 컨벤션 변경 안내

[Cassiiopeia]

🗒️ 설명

커밋 메시지 작성 방식

이슈 등록 후 개발을 시작해주세요

형식:

이슈제목: 커밋유형: 상세내용 #이슈번호

예시

해당 PR에 대해서 예시를 들겠습니다
URL 주소는 다음과 같습니다 #725

예시 커밋 메시지

[긴급][기능요청][검색] AI검색 기능 최적화 및 임베딩 관리 개선 필요: feat: AI 검색 요청 시 검색어에 대한 embedding 값 DB 캐싱 및 중복 검색어에 대해 DB 저장 embedding 값 반환 로직 작성 #725

[긴급][기능요청][검색] AI검색 기능 최적화 및 임베딩 관리 개선 필요: feat: AI 검색 요청 시 검색어에 대한 embedding 값 DB 캐싱 및 중복 검색어에 대해 DB 저장 embedding 값 반환 로직 작성 #725

💡 커밋 메시지를 이렇게 작성하는 이유

1. 커밋의 일관성 유지

   • 모든 커밋 메시지가 동일한 형식을 가지도록 통일합니다.

2. 이슈 관리 용이성

   • 깃허브 이슈 번호와 커밋 메시지가 자동으로 매핑됩니다.
   • PR 내부에서 커밋 메시지를 통해 관련 이슈를 바로 확인할 수 있습니다.

3. 변경 사항 추적

   • 커밋 로그를 통해 누가, 언제, 어떤 내용을 변경했는지 추적이 용이합니다.
   • PR에서 커서로 커밋 메시지를 가져다 대면 상세 내용을 확인할 수 있습니다.

🛠️ 깃허브 PR과의 연결 방식

커밋 메시지를 아래와 같이 작성하면, PR과 이슈 번호가 자동으로 매핑됩니다.
매핑되는 이미지 입니다.

🌟 기대 효과

1. 이슈와 커밋, PR 간의 연결성을 강화할 수 있습니다.
2. 나중에 커밋 로그를 통해 특정 변경 사항과 관련된 이슈 및 작업 내역을 쉽게 추적할 수 있습니다.

✨ TIP

1. GitToolBox 플러그인
   
   

코드 내에 commit기록을 바로 확인 할 수 있습니다

2. 인텔리제이 내장 git GUI 사용시 커밋 내용을 동일형식으로 작성하고 커밋을 눌러도 이전 커밋메시지가 삭제되지 않습니다. 해당기능을 유용하게 사용하시길 권장드립니다
   

📂 커밋 유형 정리

• feat : 신규 기능 개발
• fix : 버그 수정
• refactor : 기존 로직 개선
• docs : 문서 작성
• chore : 설정 파일 변경

🙋‍♂️ 담당자

• 백엔드: @Cassiiopeia @Chuseok22
• 프론트엔드: @newjinlee @thswogh