Home

Git Convention

Commit Convention

커밋 형식

type: subject (#issueNumber)

body 

• 제목과 본문을 포함한다.
• 각각은 빈 줄로 구분한다.

제목

제목은 변경 사항에 대한 짧은 요약으로 나타낸다.

type

• feat: 새로운 기능, 특징 추가
• fix: 수정, 버그 수정
• design: CSS 등 사용자 UI 디자인 변경
• !HOTFIX: 급하게 치명적인 버그를 고쳐야하는 경우
• style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
• refactor: 리프로덕션 코드, 리팩토링
• comment: 필요한 주석 추가 및 변경
• docs: 문서에 관련된 내용, 문서 수정
• chore: 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, 실제 코드 변경 없음
• rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
• remove: 파일을 삭제하는 작업만 수행한 경우

subject

• 명령조, 현재 시제 사용
• 끝에 .없이 작성

예시: feat: 로그인 기능 구현 (#3)

메시지 본문 body

• 선택 사항
• 명령조, 현재 시제 사용
• 어떻게 변경했는지 보다 무엇을 변경 했는지 또는 왜 변경했는지를 작

PR Convention

PR Title

[#PR number] 변경사항

• 예시: [#3] 로그인 기능
• 예시: [#11] 회원 엔티티 변경

PR 타입

하나 이상의 PR 타입을 선택하기

• 기능 추가
• 기능 삭제
• 버그 수정
• 의존성, 환경 변수, 빌드 관련 코드 업데이트

반영 브랜치

예시: feat/login -> dev

브랜치명

• ui/페이지 or 컴포넌트 이름
• feat/페이지 or 컴포넌트 or 기능 이름
• fix/기능,컴포넌트 이름

변경 사항

예시: 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.