처음에 git(깃)을 배우며 커밋메시지를 작성할 땐 그냥 대충 적었다. "기능 변경" 처럼 말이다. 그러다가 다른 사람들의 레파지토리를 구경하다 보니까 커밋메시지 그리고 코멘트를 다 영어로 적는 사람이 있었다. 멋있어 보여 따라하기 시작했다.
그랬었다
메시지를 영어로 쓰려니까 항상 하던 고민을 하게됐다. 커밋 메시지는 명사로 적나, 동사로 적나, 문장으로 적나?
그래서 다른 사람들은 어떻게 하나, 컨벤션을 찾아봤다. 당시 찾아보면서 대강 이런 컨벤션들을 보고 따라했었다.
- How to Write a Git Commit Message (2014) | Hacker News
- joelparkerhenderson/git_commit_message: Git commit message: how to write a great git commit message and commit template for version control
- Commit Message Driven Development | Sven Hofmann
- How to Write a Git Commit Message
널리 쓰이는 방법 같아보여서 채택했다.
알고있는 오픈소스 레파지토리도 둘러봤었다. 거기서는 크게 두 가지 방법이 쓰이고 있었다. 하나는 위에 적은 방법이고, 둘은 "FIX: " 등의 prefix를 붙이는 방법이었다. 여러 컨트리뷰터들이 마음대로 쓰고 있었다. 나는 둘 중 앞의 방법을 골랐다. 커밋메시지는 흔히 한 줄로 쓰긴 하지만, 사실 제목 50글자, 본문 72글자로 이루어진 하나의 짧은 글이라고 볼 수 있었다. 그래서 자연스럽게 문장형으로 적는 것이 더 멋있어 보였다.
어려움
단점은 있었다.
- 영어로 문장 짓는게 번거로웠다. 짧은 단문이나 구라서 영작 실력이 늘어나는 것도 아니었다.
- 대학에 복학하고 수업을 들으며 매일 커밋할 일이 없어졌다.
- 매일 Add, Fix, .. 적다보니 지루해졌다.
커밋메시지 적는게 지루하면 어떤가 싶지만? 안그래도 사용하기 어려운 깃을? 메시지 지어내느라 더 힘들게 쓰고 싶지 않았다.
주위 개발자들이 커밋메시지를 쓰는 것을 찾아봤다. 어떻게 쓰고 있나?
- 일단 영어로 적는 사람은 3분의 1 정도이고 나머지는 한국어로 적는다.
- 앞서 적은 방법대로 커밋메시지 적는 사람은 별로 없었고, prefix 방식이 반, prefix 없이 한국어로 적는게 반이었다.
가장 많이 쓰는 방식은 prefix를 영어로 적고 그 뒤에 한글로 쓰는 식이었다.
지금은?
그래서 나도 많이 쓰는 식대로 하기로 했다.
- prefix를 붙인다. 예시: "feat: "
- 한국어로 간결하게 적는다. 예시: "feat: 요금할인 정보 추가"
만약 한국어를 모르는 개발자와 협업한다면 영어로 적겠지만, 그게 아니라면 한국어도 괜찮다고 본다. 요새 구글 번역기가 좋아서..
아래 글들을 참고로 정하고자 했고:
- [Git] 깃 커밋 메시지 작성법(git commit message) - 1
- [Git] 좋은 커밋 메세지 작성하기위한 규칙들
- [Git] 규칙적인 Commit 메세지로 개발팀 협업하기👾
아래와 같이 정함:
