컴공생의 발자취

[Git] 좋은 커밋 메시지를 작성하기 위한 규칙 본문

🐱‍💻 Github

[Git] 좋은 커밋 메시지를 작성하기 위한 규칙

MNY 2023. 1. 4. 22:18
728x90
반응형

배경

 

캡스톤(1) 수업을 수강하면서 팀플이 있었다. 함께 프로젝트를 하며 다양한 커밋 메시지들이 함께 표시되었다. 이때까지는 커밋 메시지에 대해 별다른 생각이 없었다. 하지만, DBP 수업을 수강하고나서 조금 생각해보게 되었다. DBP 수업에서 몇몇 팀원이 커밋 메시지를 ' fix: xxx ' 또는 ' feat: xxx ' 이런 식으로 작성하는 걸 보고 ' 오... ' 라는 생각을 하였다. 그 이후 시간이 조금 지나서 지금에서야 좋은 커밋 메시지를 작성하기 위한 규칙을 찾아보고 다음과 같은 규칙들이 있다는 걸 알게되었다.

 

 

커밋 메시지의 7가지 규칙

  1. 제목과 본문을 빈 행으로 구분한다.
  2. 제목을 50글자 내로 제한
  3. 제목 첫 글자는 대문자로 작성
  4. 제목 끝에 마침표 넣지 않기
  5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
  6. 본문의 각 행은 72글자 내로 제한
  7. 어떻게 보다는 무엇과 왜를 설명한다

 

커밋 메시지 구조

type(<scope>): <subject>  -- 헤더(필수)

<body>                    -- 본문(옵션)

<footer>                  -- 바닥글(옵션)

 

 

타입

 

  • feat : 새로운 기능
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 스타일 혹은 포맷 등에 관해서.. 코드의 변경X
  • refactor : 코드 리팩토링
  • test : 테스트 코드 추가 혹은 리팩토링.. 코드의 변경X
  • chore : 그 외 자잘한 수정(패키지 매니저 구성, 빌드 작업 업데이트).. 코드의 변경X
  • build : 빌드 관련 파일 수정
  • ci : CI관련 설정 수정

 

주제

 

주제는 50자를 넘어서는 안된다. 대문자로 시작해야 하며 마침표로 끝나면 안된다.

커밋이 수행한 작업에 대해 명령형으로 작성한다.

 

바디

 

옵션이며 커밋이 약간의 설명과 문단이 필요할 때 사용한다.

바디를 적을 때, 타이틀과 바디 사이에 공백을 적어야 하고 각 줄에 글자가 72자를 넘지 않다록 해야 한다.

 

푸터

 

옵션이며 이슈트래커 아이디 참조로 사용된다.

 

커밋 메시지 예시

fix: 싫어요 음수로 내려가는 오류 수정

좋아요&싫어요 번갈아가며 클릭시 음수로 내려가는 오류 수정.
좋아요는 이상 없음.

Resolves: #13

 

 

 

 

 

 

 

 

[GIT] 커밋에 관하여(좋은 커밋 메시지, 커밋 타이밍 등)

프로젝트의 버전을 관리할 때 커밋 메세지 작성은 필수다. 하지만 어떤 메세지를 언제 커밋해야 나에게 더 나아가 팀원들에게 도움이 될 수 있을지 알고 싶었다. 좋은 변수 컨벤션이 있는 것 처

jae04099.tistory.com

 

 

[Git] 좋은 커밋 메세지 작성하기위한 규칙들

좋은 커밋 메시지 작성하기 위한 규칙들 코드를 작성하면서 어려운것들중 하나는 이름을 어떻게 짓는지에 대한 고민 바로`Naming` 일 것입니다. 클래스, 함수, 변수 등등 많은 이름을 고민하지만

beomseok95.tistory.com

 

728x90
반응형

'🐱‍💻 Github' 카테고리의 다른 글

[GitHub] 오픈소스 프로젝트 Contributor 되기 3  (0) 2023.06.10
[GitHub] 오픈소스 프로젝트 Contributor 되기 2  (0) 2023.06.10
[GitHub] 오픈소스 프로젝트 Contributor 되기  (0) 2023.04.11
[Git] 최신 Push & Commit 취소  (0) 2022.11.30
[Git] push가 안되거나 contributors에 적용 안될 때  (0) 2022.11.29
'🐱‍💻 Github' Related Articles more