인프라/Git

[Git] Git commit 컨벤션

Razelo 2022. 11. 8. 10:06

아래와 같이 조금 더 디테일하게 적어줄 수 있을 것 같다. 이전에는 feat, docs, style, chore 등은 쓴 적이 없고 Delete, Add, Fix, Test와 같은 type만 적어줬는데 아래 처럼 feat, docs, refactor 등을 활용할 수 있을 것 같다. 

 

이모지로 표현하는건 개인적으론 별로 좋지 않은것 같다. 근데 이건 그냥 개인 취향이라 하고 싶은 사람은 팀에서 잘 논의해서 결정하면 될 것 같다. 

 

아래 양식 정도만 따르면 큰 문제는 없을 것 같다. 

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • refactor : 코드 리펙토링
  • test : 테스트 코드, 리펙토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정

그리고 한 가지 주의할건. 

 

마침표는 찍지 말자. 

 

커밋 메시지에 대한 7가지 규칙을 소개한 블로그가 있었다.

 

내용은 아래와 같다. 

 

1. 제목과 본문을 빈 행으로 구분합니다. 

2. 제목을 50글자 이내로 제한합니다. 

3. 제목의 첫 글자는 대문자로 작성합니다. 

4. 제목의 끝에는 마침표를 넣지 않습니다. 

5. 제목은 명령문으로써 과거형을 쓰지 않습니다. 

6. 본문의 각 행은 72글자 내로 제한합니다. 

7. 어떻게 보다는 무엇과 왜를 설명합니다. 

 


아래 블로그에서 많은 도움을 받았습니다. 

 

감사합니다. 

 

https://da-nyee.github.io/posts/git-git-commit-message-convention/

 

[Git] 깃 커밋 메시지 컨벤션 (Git Commit Message Convention)

Introduction

da-nyee.github.io

 

https://overcome-the-limits.tistory.com/entry/%ED%98%91%EC%97%85-%ED%98%91%EC%97%85%EC%9D%84-%EC%9C%84%ED%95%9C-%EA%B8%B0%EB%B3%B8%EC%A0%81%EC%9D%B8-git-%EC%BB%A4%EB%B0%8B%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0

 

[협업] 협업을 위한 git 커밋컨벤션 설정하기

들어가며 어떻게 하면 협업을 더 잘할 수 있을까 고민하며 협업에 필요한 내용들을 계속 정리하고 있습니다. 앞으로 저와 함께 협업하는 팀원분들에게 도움이 되고 싶습니다. 이 글은 Udacity Git C

overcome-the-limits.tistory.com

 

https://koreapy.tistory.com/1150

 

[Git] Git 커밋 메시지 컨벤션 예시 (협업)

규칙적인 Commit 메세지로 개발팀 협업하기 👾 TL;DR 개발자들은 Github를 통해 git에 대한 활동을 확인할 수 있습니다. 코드의 최신화 유지와 문제 원인 발견, 신규 기능 추가에 대한 branch 분리 전략

koreapy.tistory.com

 

반응형