안녕하세요 하노입니다 :)
오늘은 개발자라면 필수로 사용하게 되는 협업 프로그램 중 하나인 Git의 Commit Messgae 규칙에 대해서 알아보려고 합니다.
커밋에도 좋은 커밋 메시지를 작성하는 법이 존재합니다. (좋은 네이밍처럼 말이죠!)
커밋 메시지를 규칙에 맞춰서 작성하면 협업하는 팀원끼리 쉽게 의사소통을 할 수 있지만,
마음대로 메시지를 입력할 경우엔 의사소통에 어려움을 겪게 됩니다...ㅠㅠ
좋은 커밋 메시지를 작성하기 위한 규칙
1. 제목과 본문은 한 줄 띄어서 구분.
2. 제목은 50자 이내로 제한.
3. 제목 첫 글자는 대문자로 작성.
4. 제목 끝에 마침표는 넣지 않음.
5. 제목은 명령문으로 과거형 사용 X.
6. 본문의 각 행은 72자 이내로 제한. (넘을 경우 줄 바꿈 사용)
7. 본문은 어떻게보다 무엇을, 왜에 대하여 설명.
커밋 메시지 구조
<type>: <subject>
<body>
<footer>
Type
- feat: 새로운 기능을 추가
- fix: 버그 수정
- build: 빌드 관련 수정
- chore: 그 외 수정 사항( 작은 수정 사항 포함)
- ci: CI 관련 설정 수정
- docs: 문서 수정
- style: 코드 스타일, 포맷 수정
- refactor: 코드 리팩토링
- test: 테스트 코드 추가 및 수정
- release: 버전 릴리즈
Subject
Typer과 함께 헤더를 구성.
Body
헤더로 표현이 가능하다면 생략 가능. 생략이 불가능하다면 자세한 내용을 함께 적어 본문 구성.
Footer
어떤 이슈에 대한 것인지 참조 정보를 표현.
오늘은 커밋 메시지 규칙에 대하여 알아보았습니다.
만약 실제로 커밋 메시지를 보고 싶으시면,
유명한 사람들의 Github, 또는 라이브러리에 커밋 내용으로 간단하고 확실하게 확인해보실 수 있습니다!
사실 개인이 진행하는 프로젝트에서는 굳이 쓰지 않아도 무방하지만,
저는 추후 다른 개발자들과의 원활한 협업을 위하여 지금부터라도 습관을 들이는 것을 추천드립니다.
그럼 오늘 글은 여기서 마치겠습니다.
감사합니다 :D
'Git' 카테고리의 다른 글
| [Git] .gitignore 파일 쉽게 만드는 법 (0) | 2022.08.18 |
|---|