Miner

git commit 규칙 본문

협업

git commit 규칙

MineTime76 2023. 11. 11. 16:49

Commit message

  • 제목(필수), 본문, 꼬리말로 구성
<type>: <subject>

<body>

<footer>

 

Type

  • feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
  • fix : 기능에 대한 버그 수정
  • build : 빌드 관련 수정
  • chore : 패키지 매니저 수정, 그 외 기타 수정
  • ci : CI 관련 설정 수정
  • docs : 문서(주석) 수정
  • style : 코드 스타일, 포맷팅에 대한 수정
  • refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
  • test : 테스트 코드 추가/수정
  • release : 버전 릴리즈

Subject

Type 과 함께 헤더를 구성합니다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있습니다.

ex) feat: Add login api

 

Body

헤더로 표현이 가능하다면 생략이 가능합니다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성합니다.

Footer

issue에 대한 commit을 #{issue number} 형태로 적어 표현합니다. (#1) close #1 처럼 close 를 통해 해당 이슈를 닫는 방법도 있습니다.

저작자표시 비영리 변경금지

'협업' 카테고리의 다른 글

Python 패키지  (0) 2023.11.11
PR (Pull Request) 규칙  (0) 2023.11.11
branch 규칙  (0) 2023.11.11
패키지 관리 : requirements.txt  (1) 2023.11.11
협업 가상환경 설정  (0) 2023.11.11
'협업' Related Articles more