며칠 전에 취업 관련 영상을 보고
PR(Pull Request)과 Code, Commit 등을 봄.PR Description이 잘 작성되어 있는지
Code가 합리적으로 작성 되어 있는지
를 확인한다는 정보를 알게 되었다.
아직 본격적인 프로젝트를 진행해본 적이 없다고 생각해서 Github를 활용하지 않았는데
작은 프로젝트라고 Git을 활용해보는 경험을 쌓으면 좋을 것 같다는 생각에 써보고자 한다.
하지만 나는 Commit Message조차 어떻게 작성하는지 모르는 상태!
따라서 공부해보고자 한다.
커밋 코멘트(Commit message)는 “왜 이 변경이 필요한지, 무엇을 바꿨는지”를 짧고 명확하게 전달하는 게 핵심입니다.
나중의 미래의 나 + 팀원이 바로 이해할 수 있어야 합니다.
1️⃣ 기본 원칙 (이것만 지켜도 평균 이상)
✅ 한 커밋 = 한 목적
- 여러 작업을 한 커밋에 몰아넣지 말기
- “버그 수정 + 기능 추가” → 커밋 분리
✅ 현재형 + 명령문
- ❌ Fixed bug, Added feature
- ✅ Fix bug, Add feature
✅ 영어 사용 권장
- 협업·오픈소스·툴 호환성 때문
(개인 프로젝트면 한글도 OK)
2️⃣ 커밋 메시지 구조 (가장 많이 쓰는 형태)
<type>: <summary>
(optional) body
예시는 아래와 같다.
fix: prevent segmentation fault in polynomial parserfeat: add visualization for Joseon dynasty lineage
- Display tree structure in ASCII
- Add color highlight for kings
3️⃣ 자주 쓰는 type 정리 (외워두면 좋음)
타입의미예시
| feat | 새로운 기능 | feat: add login validation |
| fix | 버그 수정 | fix: handle null pointer in queue |
| refactor | 리팩토링 (동작 동일) | refactor: simplify DFS logic |
| docs | 문서 수정 | docs: update README usage |
| style | 포맷/공백/세미콜론 | style: format code with clang-format |
| test | 테스트 코드 | test: add unit test for stack |
| chore | 빌드·설정 | chore: update gitignore |
'