[GIT] git commit convention (미완)

Coastby·2022년 11월 23일
0

기타

목록 보기
4/12

git commit convention

참고 : https://overcome-the-limits.tistory.com/entry/협업-협업을-위한-기본적인-git-커밋컨벤션-설정하기
https://geonlee.tistory.com/190

메세지 구조

제목, 본문, 꼬리말 세 파트로 나누며, 각 파트는 빈줄을 두어서 구분한다.

💡 메세지 구조
type: [#issueNumber - ]Subject   → 제목
( - )
body   → 본문
( - )
footer → 꼬리말

예시)

Feat: "추가 로그인 함수" 

로그인 API 개발

Resolves: #123
Ref: #456
Related to: #48, #45
  • type : 커밋의 의도
  • subject :
    • 최대 50 글자가 넘지 않는다.
    • 마침표를 찍지 않는다.
    • 영문으로 표기하는 경우 동사를 가장 앞에 두며, 첫 글자는 대문자로 표기한다.
  • body : 무엇을 왜 했는지를 작성한다. 75자를 넘지 않도록 한다.
  • footer : issue tracker ID를 명시하고 싶은 경우 작성한다.

○ 태그

태그 뒤에는 “: “을 붙여서 제목과 구별한다.

태그 이름설명
✨ feat새로운 기능을 추가할 경우
🐛 fix버그를 고친 경우
💄 designCSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE커다란 API 변경의 경우
!HOTFIX급하게 치명적인 버그를 고쳐야하는 경우
style코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
♻️ refactor프로덕션 코드 리팩토링
✏️ comment필요한 주석 추가 및 변경
📝 docs문서를 수정한 경우
✅ test테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
🔨 chore빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
🚚 rename파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
🔥 remove파일을 삭제하는 작업만 수행한 경우
🎉 init프로젝트 시작
➕ plus의존성 추가
➖ minus의존성 삭제
🗃️데이터베이스 관련 수정

○ 꼬리말 작성

  1. 꼬리말은 optional이고 이슈 트래커 ID를 작성합니다.

  2. 꼬리말은 "유형: #이슈 번호" 형식으로 사용합니다.

  3. 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.

  4. 이슈 트래커 유형은 다음 중 하나를 사용합니다.

  • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)

  • Resolves: 이슈를 해결했을 때 사용

  • Ref: 참고할 이슈가 있을 때 사용

  • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

ex) Fixes: #45 Related to: #34, #23

○ 커밋 메세지 Emoji

이모지를 사용하면 이쁘고 귀엽기도 하지만, 정보압축을 가능하게 해준다.
gitmoji 사이트에서 알맞은 이모지를 복사해서 써도 된다. 하지만 IDE의 플러그인을 이용하면 직접 검색하여 터미널에서 입력할 수도 있다.
https://bcp0109.tistory.com/372
직접 태그를 적어서 사용하는 것보다 한 번 더 사용 용도를 확인할 수 있으므로 오히려 협업 시 통일감을 주는데에는 도움이 될 것 같다. 그리고 다양한 이모지들을 볼 수 있어서 좀 더 세부적으로 나누어서 사용할 수 있을 것 같다는 생각도 들었다.
그리고 일단 시각적으로 보이는 부분이 있어서 나중에 리뷰를 할 때도 도움이 될 것 같다.

profile
훈이야 화이팅

0개의 댓글