[Git] 2. Git 컨벤션

Posted Jul 2, 2025

By Hoon

4 min read

🚀 Git Commit Convention

기본 형식

  
<type>(scope)?: <subject>

<body>

<footer>

type: 커밋의 목적
scope: (선택사항) 어떤 모듈/기능/디렉토리와 관련된 커밋인지
subject: 한 줄 제목 (명령형)
body: (선택사항) 작업한 상세 내용
footer: (선택사항) 관련 이슈나 참고사항

타입	설명	예시
`feat`	새로운 기능	feat: 댓글 작성 기능 추가
`fix`	버그 수정	fix: 로그인 시 500 에러 해결
`docs`	문서 변경	docs: README에 API 설명 추가
`style`	코드 포맷, 세미콜론, 공백	style: Prettier 적용
`refactor`	리팩토링	refactor: 로그인 로직 함수 분리
`perf`	성능 개선	perf: 이미지 로딩 최적화
`test`	테스트 코드 추가/수정	test: 회원가입 유닛 테스트 추가
`chore`	빌드/툴 관련	chore: eslint 설정 변경
`ci`	CI 관련 작업	ci: GitHub Actions 배포 스크립트 추가
`build`	빌드 관련	build: production 빌드 스크립트 추가
`revert`	커밋 되돌리기	revert: feat: 댓글 기능 추가 취소

예제

기능 추가

 feat(auth): 로그인 기능 구현

 - Firebase Auth 연동
 - 로그인 폼 상태 관리

버그 수정

 fix(comment): 댓글 중복 등록 버그 수정

 - setTimeout을 이용해 중복 클릭 방지

문서 수정

 docs: README 사용법 섹션 추가

리팩토링

 refactor(user): 유저 상태 관리 로직 개선

 - useReducer로 로직 단순화

이슈 트래킹
- Closes #이슈번호 (이슈 닫음)
- Fixes #이슈번호 (이슈 수정중)
- Resolves #이슈번호1, #이슈번호2 (이슈1,2 해결)
- Ref #이슈번호 (참고할 이슈)
- Related to #이슈번호 (이슈와 관련됨)
1 2 3 4 5 feat: api 추가 로그인 API 개발 Resolves #123

🚀 Git Branch Convention

기본 형식

<type>/<issue|feature-name>

브랜치명 규칙

띄어쓰기는 하이픈(-)으로 대체
필요하면 이슈번호 추가 가능 (ex. feat/123-login-page)
브랜치는 소문자로 작성하는 것을 권장

예제

기능
- feat/login-page
- feat/user-profile
버그 수정
- fix/comment-duplication
리팩토링
- refactor/auth-flow
문서
- docs/readme-update
작업 구분 + 이슈번호
- feat/456-new-payment-api

🚀 Github PR Convention

PR 제목

[feat] 로그인 페이지 UI 구현
[fix] 댓글 중복 등록 이슈 해결
[docs] CONTRIBUTING 가이드 추가

PR 본문

본문에는 다음과 같은 항목을 포함하면 👍

작업 내용 요약
주요 변경사항
테스트 방법 (UI, API 등)
참고 사항 (관련 이슈, 디자인 링크 등)

  
## 작업 내용
- 로그인 페이지 UI 구성
- 로그인 폼 컴포넌트 작성
- 로그인 시도 시 입력 유효성 검사 추가

## 주요 변경사항
- src/pages/LoginPage.tsx
- src/components/LoginForm.tsx

## 테스트 방법
- npm run dev로 로컬 서버 실행 후 `/login` 페이지 접근
- 이메일/비밀번호 입력 후 콘솔로 값 확인

## 참고 사항
- 로그인 API 연동은 추후 PR에서 진행 예정
- 관련 이슈: #123

Git, Git/Guide

🚀 Git Commit Convention

기본 형식

예제

🚀 Git Branch Convention

기본 형식

브랜치명 규칙

예제

🚀 Github PR Convention

PR 제목

PR 본문

인기 태그