[GitHub] 협업을 위한 Commit 컨벤션!

이전까지는, 개인 프로젝트가 많아 git commit Message를 크게 신경쓰지 않았습니다.

하지만, 여러 사람들과 개별 및 협업을 하는 경우, Commit Message는 중요합니다.

Commit Message의 구조

      commit Message는 제목, 본문, 꼬리말 세 가지로 크게 나뉩니다. 각각의 파트는 한 줄 띄어 분리합니다.

      EX>

         type (옵션, 제목) : 

 

         body (옵션, 본문) :               

 

         footer (옵션, 꼬리말) :               

 

 

- type : 

   어떤 의도로 커밋을 해야하는지 type에 명시해야 합니다.

- subject : 

  최대 50글자가 넘지 않도록 하며, 마침표를 찍지 않습니다. 영문 표기하는 경우 동사를 가장 앞에 두고 첫 글자는 대문자로 표기합니다.

- type : 

   issue tracker ID를 명시하고 싶은 경우 작성합니다.

 

type

   - 타입은 태그와 제목으로 구성되며, 태그는 영어로 쓰되 첫 문자는 대문자로 활용합니다.

   - "태그 : 제목" 의 구조를 나타내며, 뒤에만 space가 있음을 유의해야 합니다.

제목을 작성하기

      - 제목은 코드 변경 사항에 대한 짧은 요약을 나타냅니다.

      - 영어로 작성하는 경우, 첫 글자는 대문자, 명령어로 시작합니다.

      - 한글로 작성하는 경우, "고침", "추가", "변경"의 명령어로 시작합니다.

 

      - 규칙

           1. 제목의 처음은 동사 원형으로 시작합니다.

           2. 총 글자 수는 50자 이내로 작성합니다.

           3. 마지막에 특수 문자는 삽입하지 않습니다.      (예 : 마침표, 느낌표, 물음표)

           4. 제목은 개조식 구문으로 작성한다.

본문 작성하기

      - 본문은 한 줄당 72자 이내로 작성합니다.

      - 양에 구애받지 않고, 최대한 상세히 작성한다.

      - 어떻게 변경했는지보다는, 무엇을 변경했는지, 왜 변경했는지를 설명합니다.

꼬리말 작성하기

      - 본문은 한 줄당 72자 이내로 작성합니다.

      

      - 규칙

            1. 꼬리말은 optional이고 이슈 트래커 ID를 작성합니다.

            2. 꼬리말은 "유형 : #이슈 번호" 형식으로 사용합니다.

            3. 여러 개의 이슈 번호를 적을 때는 쉼표를 구분합니다.

            4. 이슈 트래커 유형은 다음 중 하나를 활용합니다.

                        - Fixes : 이슈 수정중 (아직 해결되지 않는 경우)

                        - Resolves : 이슈를 해결하였을 때 사용

                        - Ref : 참고할 이수가 있을 때 사용

                        - Related to : 해당 커밋에 관련한 커밋 이슈 (아직 해결되지 않은 경우)

 

[ 예시 ]

  Fix : "고침 모델 저장 함수"

 

  모델 개발

 

  Resolves : #628

  Ref : #111

  Related to : #22, #33 

 

Author's GitHub

https://github.com/kalelpark

kalelpark - Overview