[DEV] 기록

좋은 커밋 메시지의 7가지 규칙

꾸준함. 2021. 1. 12. 01:34

개요

학교에서 그룹 프로젝트를 진행하거나 회사에서 실무 프로젝트를 진행하면 필연적으로 깃을 사용할 수 밖에 없습니다.

보통 커밋을 할 때 귀찮다고 대충 메시지를 작성하는 경우가 있는데, 이럴 경우 시간이 어느정도 지나고 다시 특정 커밋 내역을 보고 싶을 때 어떤 커밋 내역을 봐야할지 모르기 때문에 곤란한 상황이 발생합니다.

 

현재 참여한 프로젝트에서 깃을 적극 활용하고 있기도 하고 작년보다 많은 사람들과 개발을 진행하고 있기 때문에 앞으로는 커밋 메시지를 꼼꼼히 작성해야하는 상황이기 때문에 좋은 커밋 메시지의 7가지 규칙을 정리하고 해당 규칙들을 지키도록 노력하겠습니다.

 

좋은 커밋 메시지의 7가지 규칙

1. 제목과 본문을 빈 줄로 분리합니다.

2. 제목은 50자 이내로 작성합니다.

3. 제목을 영어로 쓸 경우 첫 글자는 대문자로 작성합니다.

4. 제목에는 마침표를 넣지 않습니다.

5. Use the imperative mood in the subject line

-> Imperative mood just means “spoken or written as if giving a command or instruction”

즉, 명령조로 제목을 작성합니다.

6. 본문을 72자 이내로 작성합니다.

7. 어떻게보다 무엇(what)과 왜(why)를 설명합니다.

 

[출처]

chris.beams.io/posts/git-commit/#wrap-72

 

How to Write a Git Commit Message

Introduction | The Seven Rules | Tips Introduction: Why good commit messages matter If you browse the log of any random Git repository, you will probably find its commit messages are more or less a mess. For example, take a look at these gems from my early

chris.beams.io

 

 

반응형