티스토리 뷰

Development/Git

[Git]Git Commit Message Guidelines

Vagabund.Gni 2022. 9. 27. 17:27
728x90
반응형

출처: https://cbea.ms/git-commit/#limit-50

 

How to Write a Git Commit Message

Commit messages matter. Here's how to write them well.

cbea.ms

Git은 개발자가 본인의 코드를 공개하고 다른 사람들과 협업할 수 있게 도와주는 버전 관리 시스템이다.

 

단계에 따라 여러 명령어가 있지만 그중 가장 중요한 것은 역시 커밋(Commit)이라 할 수 있다.

 

커밋을 하면 그 시점의 개발자의 작업공간의 스냅샷을 찍어 로컬 레포지토리로 올리기 때문이다.

 

즉, 이전 버전과 비교하거나 돌아갈 수 있는 일종의 저장 포인트가 생성된다는 뜻이다.

 

커밋 메시지는 바로 이 커밋을 실행 할 때 반드시 추가해야 하는 정보인데,

 

변경 사항의 정확한 이유를 알려줄 수 있는 유일한 정보가 되기에 중요하다.

 

즉, 간결하면서도 직관적인 커밋 메시지는 협업 뿐 아니라 미래의 나에게 도움이 된다는 뜻이다.

 

이 커밋 메시지를 작성하기 위한 몇 가지 규칙이 있어서 기억을 위해 기록한다.

 

Commit Message Guidelines

 

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain What and Why instead of How

 

  • 제목과 본문은 빈 행으로 구분
  • 제목은 50글자 안으로 작성
  • 제목 첫 글자는 대문자로 작성
  • 제목 끝에 마침표 찍지 않기
  • 제목은 명령문으로 작성하되 과거형은 지양
  • 본문의 각 행은 72글자 안으로 작성
  • 어떻게(How) 보다는 무엇(What)과 왜(Why)를 설명
반응형

'Development > Git' 카테고리의 다른 글

[Git]로컬 폴더 원격 레포지토리에 올리기  (1) 2023.01.26
[Git]Pull과 Fetch 차이(feat. Clone)  (2) 2022.09.27
[Git]GitHub Workflow  (2) 2022.09.08
댓글
공지사항
최근에 올라온 글
최근에 달린 댓글
Total
Today
Yesterday
링크
«   2024/11   »
1 2
3 4 5 6 7 8 9
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
글 보관함