• 강천성 멘토님 github 특강 자료

  Github - Google Drive

Convention

Commit Convention

• Commit Convention이란 Commit을 남기는 규칙이라고 생각하시면 됩니다.
• 이러한 규칙을 사용하는 이유는 일관적인 Commit Log를 통해 서로 다른 사람들이 작업한 내용을 쉽게 파악하고, 유지보수 할 수 있도록 하기 위함입니다.
• Modern Commit Convention은 Header, Body, Footer로 구성되며, 여기에서 Body와 Footer는 선택적으로 사용할 수 있습니다.

[Git] Commit Message Convention

Header

• Commit Log의 제목을 나타내는 Header 부분입니다.
  • 50자를 넘기지 않고, 대문자로 작성하며 마침표를 붙이지 않습니다.
  • 과거 시제를 사용하지 않고 명령어로 작성합니다.
    • ex) Added(x), Add(o)
• 일반적으로 Header에는 Tag가 붙으며, Tag 뒤로 작업의 대략적인 내용이 붙습니다.
• feat(새로운 기능), refactor(리펙토링), fix(버그 수정), style(코드 포멧팅 또는 주석처리), chore(빌드 수정, 패키지 관리자 수정), tests(테스트 코드), docs(문서 작업) 등이 있습니다.
• ex) feat: add rest api code, feat - add rest api code

Body

• 말 그대로 작업에 대한 상세 기록을 나타내는 본문입니다. Header와 달리 특별한 Format은 존재하지 않습니다. 다만 Header와는 한칸 공백을 만들어주세요.

• Header에서 한줄로 설명이 가능한 수준이라면 Body는 생략해도 되지만, 그렇지 않은 경우라면 Header를 더 간략하게 작성하고 Body에 내용을 추가합니다.

• Header와 구분될 수 있도록 한칸 띄워 작성하며 72자를 넘기지 않도록 합니다.

  예시)

  • Case 1: Body가 생략되는 경우

    feat : add multiply function with two variables.
    

  • Case 2: Body가 생략되지 않는 경우

    refactor: modify api handler logic
    - change logic 1
    - change logic 2