Commit Convention

함께 개발을 하며 효과적인 의사소통은 작업을 더 잘할 수 있게 만들어줍니다.

잘 다듬어진 Commit message는 일일이 코드를 확인하지 않아도 직관적으로 해당 작업 내용을 알 수 있게끔 도와줍니다. 또한, 잘 관리된 로그들은 git blame 이나 revert, rebase, log 등 git의 명령어들과 좋은 상호작용을 만들며 Code review를 더 잘할 수 있도록 만들어줍니다.

효과적인 Commit message 작성을 위해 아래의 포맷을 사용합니다.

Template

[Ticket Number or Prefix] Summary #command
{content}
{footer}
Bash
복사

Rule

•

제목과 본문은 빈 행으로 분리합니다.

•

제목은 50자 이내로 작성하며, 명령 / 지시 구문으로 작성합니다. (~로 설정, ~를 삭제...)

•

한글 사용을 권장하나, 경우에 따라 영문으로 작성할 경우 첫 글자는 대문자로 작성합니다.

•

내용은 Bullet(-) 형태로 작성하며, 어떤 이유로 무엇을 수정하였는지 명시합니다.

•

Footer에는 Metadata를 작성하며, 필요한 경우에만 작성합니다.

Recommendation

JIRA 티켓이 있는 경우 → 제목 앞에 티켓 번호를 붙입니다

제목에 Ticket Number를 명시합니다. (JIRA에서 해당 이슈에 대한 커밋을 쉽게 볼 수 있습니다)

Ticket Number는 한 branch에 하나만 사용하며, 해당 작업이 상하관계에 있는 두 티켓에 연관되어 있다면, 가급적 Story의 Ticket Number를 기재합니다.

  올바른 경우

  잘못된 경우

JIRA 티켓이 없는 경우 → 아래의 Prefix 규칙을 따릅니다

일반적인 기능 개발 / 개선 작업 — feat:(띄어쓰기)

HOTFIX 및 버그 수정 — FIX:(띄어쓰기), HOTFIX:(띄어쓰기) 대문자를 사용하는 이유는 Commit Graph에서의 가시성을 높이기 위함입니다.

그 외의 마이너한 작업들 — minor:(띄어쓰기)

  올바른 경우

  잘못된 경우

Commit의 제목은 명령 / 지시 구문으로 작성합니다

해당 커밋이 반영되면 어떤 결과를 가져올 것인지 명확하게 나타나도록, 명령 / 지시 구문으로 작성합니다.

•

이 변경사항이 적용되면 Swap 함수를 Arrow함수로 수정

•

If applied, this commit will, Remove deprecated Swap methods

  올바른 경우

  잘못된 경우

(중요) 내용에 어떤 이유로 무엇을 수정하였는지 명시합니다.

메세지를 생략할 수는 있으나, 이 경우에는 제목에 수정 내역을 명시적으로 인지할 수 있어야 합니다.

코드 자체의 변경사항은 diff나 blame으로 확인할 수 있지만, 변경한 이유를 파악하기 위해서는 많은 시간이 걸릴 수 밖에 없습니다.

코드 작업의 상세한 설명, 혹은 코드 변경의 이유를 내용에 Bullet(-) 형태로 적어줍니다. 코드 변경의 경우, 변경 전의 동작과 이후의 동작을 명시하여 나중에 디버깅 시 참조할 수 있도록 합니다.

단, 내용이 너무 많거나 산만하다면 코드에 주석으로 남깁니다.

  올바른 경우

  잘못된 경우

Footer

제목, 내용 이외에 다른 작업자가 해당 커밋에 대하여 참고할 수 있는 내용을 맨 아래 Footer에 작성합니다. 정해진 양식은 없습니다.

Title
...content...
ref: 36f0e2395f2f9ccbf576d87b73fe924c39d9dd49
Plain Text
복사

References

How to Write a Git Commit Message

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 days committing to Spring: $ git log --oneline -5 --author cbeams --before "Fri Mar 26 2009" e5f4b49 Re-adding ConfigurationPostProcessorTests after its brief removal in r814.

https://chris.beams.io/posts/git-commit/

해줌스토리

저는 각자 컴퓨터 앞에서 따로 코딩하는 와중에도 함께 일하고 있다는 기분을 느끼고 싶었습니다. 함께 일하기 위해 우리는 회의를 잡고, 따로 이야기하고, 이메일을 쓰고, 일감관리 시스템을 사용하고 있습니다만, 우리(개발자와 데이터 사이언티스트)가 하는 가장 많은 시간을 쏟는 일 -코드를 생산하는 것-과는 동떨어진 작업이라는 느낌을 지울 수 없었습니다.

http://story.haezoom.com/?p=936