commit message

윤지영·2023년 7월 14일
0

guide

목록 보기
1/3

커밋 메시지 작성

  • 커밋은 기능단위로 !!
    커밋 타입 : 동작 이름/함수 이름

    Feat: "로그인 함수 추가"    // 제목  
    
    로그인 요청을 위한 함수 구현    //본문
    
    Closes: #123    //꼬릿말

* 예시

 Env: File setting  `첫 파일 생성 시`
 Feat: Creat 기능/파일명
 Feat: Add 기능/파일명
 Feat: Update/파일명
 Refactor: Common module `리팩토링 모듈분리`

* 기능 예시

  • Feat : 새로운 기능 추가
  • Fix : 버그 수정
  • Env : 개발 환경 관련 설정
  • Style : 코드 스타일 수정
    • 세미 콜론, 들여쓰기 등의 스타일적인 부분만
    • css 관련 : Design
  • Refactor : 코드 리팩토링 (더 효율적인 코드로 변경 등)
  • Design : CSS 등 디자인 추가/수정
  • Comment : 주석 추가/수정
  • Docs : 내부 문서 추가/수정
  • Test : 테스트 추가/수정
  • Chore : 빌드 관련 코드 수정, 자잘한 수정(기타 변경)
  • Rename : 파일 및 폴더명 수정
  • Remove : 파일 삭제

* 7가지 메세지 규칙을 지킵니다.

(출처: https://cbea.ms/git-commit/)

  1. 제목과 본문은 한 줄을 띄워서 작성한다.
  2. 제목은 영문 기준 50자 이내로 작성한다.
  3. 제목 첫글자는 무조건 대문자로 작성한다.
  4. 제목 끝에 마침표(.)는 찍지 않는다.
  5. 제목은 개조식 (영어라면 명령문// 동사_명사) 으로 작성한다.
    (Update code, Fix bug 등으로만 작성, 만약에 한글로 작성한다면 ‘abc 함수 수정’ 과 같은 식으로)

* 좋은 git commit 메시지를 위한 영어 사전

https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

profile
쑥쑥쑥쑥 레벨업🌱🌼🌳

0개의 댓글