🎯 Git Commit Message 작성 가이드

슘·2024년 11월 25일

🎯 개발 가이드

목록 보기

1/3

프로젝트 관리와 협업의 효율성을 높이기 위해 Git 커밋 메시지를 체계적으로 작성하는 방법을 소개합니다. 커밋 메시지 작성은 단순히 작업 내용을 기록하는 것이 아니라, 팀원들과 작업 내역을 공유하고 변경 사항을 추적할 수 있도록 돕는 중요한 과정입니다.

1. 기본 Git 커밋 메시지 형식

<type>(<scope>): <subject>

<body>

<footer>

* 필드 설명

type: 변경 사항의 종류를 나타냅니다. (예: feat, fix, docs 등)
scope: (선택) 변경 사항의 범위를 명시합니다. (예: auth, api)
subject: 커밋 내용을 간략히 요약합니다. 명령형으로 작성합니다.
body: (선택) 변경 사항의 구체적인 내용을 설명합니다.
footer: (선택) 이슈 번호나 관련 정보를 추가합니다.

2. type의 종류와 의미

Type	설명
`feat`	새로운 기능 추가
`fix`	버그 수정
`docs`	문서 변경 (예: README 수정)
`style`	코드 스타일 변경 (예: 포매팅, 세미콜론 추가/제거, 공백 조정 등)
`refactor`	리팩토링 (기능 변경 없음)
`test`	테스트 코드 추가 또는 수정
`chore`	빌드 프로세스, 패키지 매니저 설정 등 개발 환경 변경

3. 커밋 메시지 작성 예시

1) 새로운 기능 추가

feat(auth): add login feature with JWT

- Implement user authentication with JWT tokens
- Add token verification middleware in backend
- Create login form on the frontend

2) 버그 수정

fix(api): resolve 500 error on user fetch

- Fix incorrect query parameters causing server errors
- Update API documentation for the user endpoint

3) 문서 변경

docs: update contributing guidelines

- Add a section for Git commit message format
- Update example commands for environment setup

4) 코드 스타일 변경

style: format code with Prettier

- Apply Prettier to all JavaScript files
- Update ESLint configuration for better compatibility

5) 리팩토링

refactor(auth): simplify login validation logic

- Replace nested if-else statements with guard clauses
- Add a utility function for input validation

4. 효율적인 커밋 메시지를 위한 도구

Commitizen

CLI 도구를 사용해 커밋 메시지를 표준화 할 수 있습니다.

npm install -g commitizen
git cz

Lint-staged & Husky

Git 훅을 사용해 커밋 메시지를 자동으로 검증할 수 있습니다.

5. 커밋 메시지 작성 팁

변경 사항의 이유와 목적을 중심으로 작성하세요.
메시지는 간결하고 명확하게 작성하세요.
영어로 작성하는 것이 보편적이지만, 팀 규칙에 따라 한글도 가능합니다.
프로젝트 초기에는 팀원들과 메시지 형식에 대한 규칙을 합의하세요.

🚀 결론

체계적인 커밋 메시지는 프로젝트의 품질을 높이고, 협업 효율성을 증대시키는 데 중요한 역할을 합니다. 위에서 소개한 방법과 형식을 참고해, 일관된 메시지를 작성하는 습관을 길러보세요! 😊

슘

주니어 프론트엔드 성장기 기록기록

다음 포스트