팀 컨벤션 - FinalProject-AIPARK/JenaPark-BE GitHub Wiki

Commint Convention

type: subject - Issue #num

body

• 제목, 본문 두가지 파트로 나누고, 각 파트는 빈줄을 두어 구분

• 제목 끝에 . 금지

• 제목은 간략하게 간추리기 (50자 이내)

• 제목 첫글자는 대문자

• 영문으로 표기하는 경우 동사(원형)를 가장 앞에 (과거 시제를 사용하지 않음)

  ex) Fixed (x) -> Fix (0) 
  

• 본문은 상황에 따라 생략 가능

• 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명

📌type 종류

type	설명
feat	새로운 기능 추가
fix	버그 수정
style	코드 포맷팅, 세미콜론 추가 등 코드 변경이 없는 경우
docs	문서 수정
refactor	코드 리팩토링
conf	패키지 매니저 등 빌드 관련 설정 수정
test	테스트 코드 작성
chore	그외 자잘한 수정 및 설정

📌Issue #num

평소 커밋시 사용

• Issue #13 - 기능에 해당하는 이슈에 연결

이슈를 닫을 때

• Close #14 - 일반 개발 이슈
• Fix #15 - 버그 픽스 이슈

문의나 요청 사항 대응

• Resolve #16

해당 구문이 commit에 들어가면 github이 자동으로 인식해 이슈를 종료