Jello's development blog

Jello's development blog

좋은 깃(Git) 커밋 메시지 작성법

들어가며

개발을 하면서 하루에도 몇 번씩 커밋 메시지를 작성하게 된다. 습관적으로 작성하다 보니 나만 알아볼 수 있게 적는 경우도 많고, 의미가 명확하지 않아서 코드를 유심히 살펴보아야 하는 경우도 있다. 이렇게 의미 전달이 제대로 되지 않는 커밋 메시지는 좋지 않은 커밋 메시지이다. 나의 경우도 급할 때나(급할 때 개발하면 안되지만), 메시지를 작성하기 귀찮아지면 아무렇게나 적어버리는 경우가 있었다. 좋은 커밋 메시지를 작성하려면 어떻게 해야 하는지 알아보자.

커밋 메시지의 역할

커밋 메시지는 왜 적는 것일까?
바로 코드를 다시 볼 때, 어떻게 개발이 되었는지 흐름을 파악하고, 특정 개발이 어느 시점에 되었는지 파악하기 위해서이다. 매일 몇 개씩 작성하는 커밋 메시지가 귀찮아도 절대 막 적어서는 안되는 이유이다.

좋은 커밋 메시지란?

좋은 커밋 메시지란 어떤 것일까? 위에서 설명한 조건을 만족스럽게 지키는 커밋 메시지이다. 즉, 메시지만 봐도 빠르게 무엇을 어떻게 개발했는지 개략적으로 파악이 가능한 메시지이다. 어떻게 작성해야 이 조건을 만족시킬 수 있을까?

1. 무엇을 했는지 간단 명료하게 작성한다.

커밋 메시지의 가장 윗 줄은 무엇을 했는지 한 눈에 알아볼 수 있게 작성한다. 쓸데 없는 미사여구를 제외하고 무엇을 했는지만 간단 명료하게 작성한다.

2. 첫 줄은 50자, 그 밑의 줄부터는 70자 내로 작성한다.

위에서도 설명했듯이, 커밋 메시지의 가장 윗 줄은 무엇을 했는지 한 눈에 알아볼 수 있게 작성해야 하므로, 길어도 50자 내로 작성한다. 두 번째 줄은 확실하게 제목과 설명을 나누기 위해서 비워두고, 세 번째 줄부터는 무엇을 했는지 구체적으로 자세하게 적는다. 이 작업이 가장 귀찮을 수 있지만, 첫 줄으로 의도를 파악하기 힘든 경우, 커밋터의 의도를 파악할 수 있다.

3. 첫 문자는 대문자로 작성한다.

첫 문자를 대문자로 작성하게 되면 훨씬 보기 편하다.

4. 첫 줄에는 마침표를 찍지 않는다.

이메일 제목에 마침표를 찍지 않듯이, 커밋 메시지의 제목 격인 첫 번째 줄에도 마침표를 찍지 않는다. 첫 줄에서 마침표는 필요하지 않다.

마치며

위에서 말한 대로 커밋 메시지를 쓴다는 것은 참 어려운 일이다. 그래도 노력하여 습관을 들인다면, 누군가(혹은 미래의 자신) 이 코드를 보게 될 때, 어떻게 개발되었는지 한 눈에 파악할 수 있을 것이다. 그 것이 더 높은 개발자로 가는 길이기도 하다.

참고링크