커밋 메시지 7가지 규칙
1. 제목과 본문을 한 줄(빈 행) 띄어 구분한다.
2. 제목은 50자 이내로 제한한다.
3. 제목 첫 글자는 대 문자로 작성한다.
4. 제목 끝에 마침표(.) 금지
5. 제목은 명령문으로, 과거형 X
6. 본문의 각 행은 72자 내로 작성한다. (줄 바꿈 사용)
7. 본문은 어떻게 보다 무엇을, 왜에 대하여 설명한다.
커밋 메시지 구조
<type>: <subject>
<body>
<footer>
Subject
Type 과 함께 헤더를 구성합니다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있습니다.
ex) feat: Add login api
Type(해당 커밋의 성격을 나타내며 아래 중 하나여야 한다)
- feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정 커밋
- fix : 기능에 대한 버그 수정 커밋
- build : 빌드 관련 수정 / 모듈 설치 또는 삭제에 대한 커밋
- chore : 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
- ci : CI 관련 설정 수정
- docs : 문서(주석) 수정
- style : 코드 스타일, 포맷팅에 대한 수정
- refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
- test : 테스트 코드 추가/수정
- release : 버전 릴리즈
Body
Header에서 표현할 수 없는 상세한 내용을 적는다.
Header에서 충분히 표현할 수 있다면 생략 가능하다.
Footer
바닥글로 어떤 이슈에서 왔는지 같은 참조 정보들을 추가하는 용도로 사용한다.
예를 들어 특정 이슈를 참조하려면 Issues #1234 와 같이 작성하면 된다.
Footer는 생략 가능하다.
'소프트웨어 개발 > GitHub' 카테고리의 다른 글
| [Git] Unity GitHub 참고사항 (0) | 2024.09.09 |
|---|---|
| [Git] GitHub 사용법 및 기본 (5) | 2024.07.24 |
