[GIT] : git convention

Git convention ?

Git 컨벤션은 Git을 사용하는 프로젝트에서의 commit 규칙과 가이드라인의 집합입니다.

위 컨벤션은 코드 변경 이력을 더 명확하게 관리하고 협업을 개선하기 위해 사용됩니다.

 

사용 목적

• 문서화 : 코드 변경내용을 기록함으로써 누가, 언제, 어떤 변경작업을 진행했는지를 문서화 할 수 있다.
  서로 작업한 코드의 내용 이해를 돕기위해 사용될 수 있다.
• 협업: 다수의 개발자가 동시에 작업할 때, 코드 변경 사항을 명확하게 정의하고, 다른 개발자에게 알리기 위해 사용한다.
  이렇게 하면 코드 충돌을 최소화하고 팀원 간의 이해관계를 높일 수 있다.
• 자동화: 일부 도구 및 서비스는 Git 컨벤션을 활용하여 자동으로 버전 릴리스 노트를 생성하거나 특정 작업을 자동화할 수 있다.

 

Type

일반적으로 Git 컨벤션은 변경 내용의 "타입"을 정의한다.
이 타입은 어떤 종류의 변경이 이루어졌는지를 나타내며, 주로 다음과 같은 타입들이 사용된다.

• feat: 새로운 기능 추가
• fix: 버그 수정
• refactor: 코드 리팩토링 (기능 변경 없음)
• chore: 빌드 프로세스 업데이트, 패키지 관리자 설정 변경 등과 같은 기타 작업
• style: 코드 스타일, 포맷팅 수정 (기능 변경 없음)
• docs: 문서 수정
• test: 테스트 코드 추가 또는 수정
• perf: 성능 개선 관련 변경
• ci: CI/CD 설정 및 스크립트 수정

이러한 타입은 코드 변경 내용을 빠르게 식별할 수 있도록 도와줄 수 있다.

### 제목
# 커밋 타입: 작업내용 (제목과 본문은 한 줄 띄워주세요)


### 본문 - 한 줄에 최대 72 글자까지만 입력하기  
# 무엇을, 왜, 어떻게 했는지


# 꼬리말
# (선택) 이슈번호 작성

#   [커밋 타입]  리스트
#   feat      : 기능 (새로운 기능)
#   fix       : 버그 (버그 수정)
#   design    : CSS 등 사용자 UI 디자인 변경
#   refactor  : 리팩토링
#   style     : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs      : 문서 (문서 추가, 수정, 삭제)
#   test      : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore     : 기타 변경사항 (빌드 스크립트 수정 등)
#   post      : 블로그 포스트 추가 (신규 포스트 작성 및 수정)
#   rename    : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우
#   remove    : 파일을 삭제하는 작업만 수행한 경우
# ------------------
#   [체크리스트]
#     제목 첫 글자는 대문자로 작성했나요?
#     제목은 명령문으로 작성했나요?
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분했나요?
# ------------------

 

Type 을 이용한 사용 예시

• feat(user-auth): 새로운 사용자 인증 기능 추가
• fix(ui): UI 버튼이 제대로 클릭되지 않는 버그 수정

 

Git convention 을 이용해보니까, 분업을 통한 작업의 효율성은 올라가고, 해당 코드를 이해하며 다음 로직을 구상하기 까지의 과정이 굉장히 줄어든다는걸 체감했다.

잘 짜여진 convention 을 활용하여 협업을 진행한다면, 기분좋게 이쁜 프로젝트를 팀원들과 같이 진행한다는 느낌으로 할 수 있다는걸 알았다.

 

#git 
#convention #협업 #사용예시