상세 컨텐츠

본문 제목

Git Commit Message 작성 규칙

팁/Git

by 강효재 2020. 8. 3. 12:11

본문

1)공통 규칙 

 - 메시지 본문에 변경 사항을 상세히 작성한다.

 

2) 커밋 메시지 구성

[유형] 제목

 

본문 (제목만으로 표현이 가능할 때는 생략 가능)

 

꼬리말 [유형]:#이슈번호 (관련 이슈가 없으면 생략 가능)

유형에 해당되는 3가지 1) 해결, 2) 관련(아직 해결되지 않은 관련 이슈) 3) 참고

 

 

3) 커밋 메시지 유형

  1. 기능 개발 : [feature development]
  2. 기능 삭제 : [feature delete]
  3. 기능 변경 : [feature modify]
  4. 버그 수정 : [bug fix]
  5. 리팩토링 : 코드 리펙토링 [refactoring]
  6. 형식 : 코드 형식, 정렬, 주석 등의 변경 [form]
  7. 테스트 : 테스트 코드 추가, 삭제, 변경, 수행 등 [test]
  8. 문서 : 문서 추가, 삭제 변경 : [document]
  9. 프로젝트 : 프로젝트 관리 측면에서 모든 변경 ex) 빌드 스크립트 수정, Git설정, 패키지 배포 설정 변경 등 [project]
  10. 버전 업데이트 : [version update]
  11. 충돌 수정 : [resolve conflict]
  12. 기타 : [etc]

4) 명명규칙 예)

* 기능개발 [feature development] 기능개발 제목 #번호 

          - 내용상세

    * [feature development] 챗봇 답변 리스트 UI 작업 #1

                    - 더미 값으로 UI 구현.

    * [feature development] 챗봇 답변 리스트 UI 작업 #2

                    - UI 구현

                    - 더미데이터 구현

                    - 로직 구현

 

* 버그수정 [bug fix] 지라 이슈 번호 및 제목. 또는 이슈 해결 제목

    * [bug fix] [SKT] COMMASKTCOMMA-337 

                        iOS - 사용자 설정> PC버전 관리> 사용중지 버튼 UI 위치 오류

    * [bug fix] 대화방 강퇴

                        - 방장이 아닌 경우 강퇴 기능 비활성화

 

* 버전 업데이트 [version update]

    * [version update] 5.8.0(네트웍 오앤에스)

 

* 충돌 수정 [reslove conflict] 자동 기입 됨. 또는 상세항복지정

    * ) 자동

                     Merge branch '2017dev_January_Second' into preRelease

 

                    * 2017dev_January_Second:

                    [bug fix] 2017년이슈리스트 207 해결 - 공지글 설정 시 이모티콘 작성되어 있는 글일경우 영역이

                     오버되서 보이는 증상 발생

                    [feature development] 2016고도화 12 - '공지 등록 제한 해제' 로직 수정 - API수정

                    '글 수정'시 공지여부 및 공지사항 유효 기간 값을 넣어주지 않는다.

 

                    # Conflicts:

                    # ttalk/Common/CommonDefine.h

 

    * ) 수동

    * [resolove conflict] cherry pick (23c8efa6)

                        [bug fix] [SKT] COMMASKTCOMMA-317

 

 꼬리말)

   해결:#123

   참고:#125

 

웹사이트 검색과 현재 사용중인 사내 규칙을 조합하여 부족하다고 생각되는 부분을 추가함.

 

참고한 출처 : https://tttsss77.tistory.com/58

 

Git 사용 규칙 - Git commit 메시지

Git 사용 규칙 - Git commit 메시지 본 글에서는 더 나은 커밋 로그 가독성, 협업 및 리뷰, 코드 유지보수를 지원하기 위한 깃 커밋 메시지 규칙을 정리한다. 공통 규칙 1. 커밋 메시지는 최대한

tttsss77.tistory.com