[Git, Github] git commit message 자세히 작성하기

JUNHO YEOM·2022년 11월 30일
0

Git, Github

목록 보기
14/27
post-thumbnail
post-custom-banner

git commit

커밋 메시지에서는 어떤 작업을 했는지 누구나 알 수 있도록 커밋 메시지를 작성해야 합니다.
하나의 커밋에는 하나의 작업단위가 담길 수 있도록 해야 합니다.


commit convention

개발 팀원들끼리 개발 설정을 정해놓는 방식을 말합니다.


commit message convention

널리 사용되는 커밋 메시지 작성 방식을 말합니다.

작성 형식

type: subject

body (optional)
...
...
...

footer (optional)

예시

feat: 압축파일 미리보기 기능 추가

사용자의 편의를 위해 압축을 풀기 전에
다음과 같이 압축파일 미리보기를 할 수 있도록 함
 - 마우스 오른쪽 클릭
 - 윈도우 탐색기 또는 맥 파인더의 미리보기 창

Closes #125

git commit을 통해서 vim에서 commit message내용을 자세히 작성할 때 사용합니다.


Type

타입설명
feat새로운 기능 추가
fix버그 수정
docs문서 수정
style공백, 세미콜론 등 스타일 수정
refactor코드 리팩토링
perf성능 개선
test테스트 추가
chore빌드 과정 또는 보조 기능(문서 생성기능 등) 수정


Subject

커밋의 작업 내용을 간단히 설명합니다.


Body

commit 내용을 길게 작성할 필요가 있을 시 작성합니다


Braking Point 가 있을 때,
특정 이슈에 대한 해결 작업일 때 작성합니다.


post-custom-banner

0개의 댓글