Skip to content

Qvil Blog

Github

[Git] Commit Convention 좋은 커밋 메세지 작성법

— git, convention — 1 min read

  • Table of Contents {:toc}

아래 참고사이트를 요약하였음.

1. 제목과 본문을 한 줄 띄워 분리

  1. 50자 이내의 요약 문장
  2. 빈 줄 하나
  3. 설명문

위 가이드를 따르면 아래 명령어를 이용할 때 보기 편리함. + git에서 추천함

1git log --oneline
2git shortlog

2. 제목은 영문 기준 50자 이내

3. 제목 첫글자 대문자

4. 제목 끝에 . 금지

5. 제목은 명령조

git Built-in Convention을 따른다.

예문

Good

1(If applied, this commit will) Refactor subsystem X for readability

Bad

1(If applied, this commit will) Fixed bug with Y

6. 본문은 영문 기준 72자마다 줄 바꿈

7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성

좋은 예

1commit eb0b56b19017ab5c16c745e6da39c53126924ed6
2Author: Pieter Wuille \<[email protected]\>
3Date:   Fri Aug 1 22:57:55 2014 +0200
4
5   Simplify serialize.h's exception handling
6
7   Remove the 'state' and 'exceptmask' from serialize.h's stream
8   implementations, as well as related methods.
9
10   As exceptmask always included 'failbit', and setstate was always
11   called with bits = failbit, all it did was immediately raise an
12   exception. Get rid of those variables, and replace the setstate
13   with direct exception throwing (which also removes some dead
14   code).
15
16   As a result, good() is never reached after a failure (there are
17   only 2 calls, one of which is in tests), and can just be replaced
18   by !eof().
19
20   fail(), clear(n) and exceptions() are just never called. Delete
21   them.

[팁] 커밋 메세지로 Github 이슈(issue)를 자동 종료시키기

아래 문법으로 커밋 메세지를 남기면 default branch(master)에 푸시 될 때 이슈 닫힘.

1키워드 #이슈번호

Github 이슈 종료 키워드

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

관례

close계열 : 일반 개발 이슈 fix계열 : 버그 픽스, 핫 픽스 이슈 resolve : 문의, 요청 사항에 대응한 이슈

예문

1# 제목에 이슈 한 개 닫기를 적용한 사례
2Close #31 - refactoring wrap-up
3
4* This is wrap-up of refactoring main code.
5* main.c
6  * removed old comments
7  * fixed rest indentations
8  * method extraction at line no. 35
9
10
11# 본문에 이슈 여러 개 닫기를 적용한 사례
12Update policy 16/04/02
13
14* This closes #128 - cab policy, closes #129 - new hostname, and fixes #78 - bug on logging.
15* cablist.txt: changed ACL due to policy update delivered via email on 16/04/02, @mr.parkyou
16* hostname.properties: cab hostname is updated
17* BeautifulDeveloper.java: logging problem on line no. 78 is fixed. The `if` statement is never happening. This deletes the `if` block.