Rubberduck-Debugging

git log message 본문

개발자

git log message

P缶 2018. 12. 9. 15:38

좋은 커밋 메시지 작성을 위한 약속

  1. 제목과 본문을 한 줄 띄워 분리한다
  2. 제목은 가급적 50자로 제한하며, 최대 69자를 넘지 않는다
  3. 제목은 명령조로 작성한다
  4. 제목 끝에 마침표(.)는 찍지 않는다
  5. 본문은 적당한 위치에서 개행을 한다
  6. 본문은 어떻게 보다는 무엇 과  를 설명한다 (코드는 보통 따로 설명될 필요가 없다)

Tip. 제목은 명령조로 작성한다

  • 좋은 제목

    • 가독성을 위해 서브시스템 X를 리팩토링한다 (Refactor subsystem X for readability)
    • Getting Started 문서를 갱신한다 (Update getting started documentation)
    • Deprecated된 메소드를 삭제한다 (Remove deprecated methods)
    • 버전 1.0.0으로 판올림한다 (Release version 1.0.0)


  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, …)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

이 정도의 구분만 명확히 하고 사용해도 좋은 commit log가 되겠다. commit log를 보고 실망한 면접관이 있어 글 남겨본다.

출처 : https://www.slipp.net/questions/525

'개발자' 카테고리의 다른 글

소프트웨어 개발자 로드맵 링크들  (0) 2019.01.21
ajax error message  (0) 2019.01.01
Spring MVC  (1) 2018.12.06
printf, SimpleDateFormat  (0) 2018.12.04
여기어때 면접에서 듣게 되는 질문  (0) 2018.12.03