ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • 좋은 커밋 메시지 작성법
    기타 개발 관련 2025. 4. 17. 16:24
    반응형

    좋은 커밋 메시지는 변경 사항을 명확하게 설명하고, 나중에 기록을 빠르게 파악할 수 있도록 도와줍니다. 특히 팀 개발에서는 협업과 디버깅 효율을 높이는 중요한 수단이 됩니다.

     

    일반적인 규칙

    <타입>: <변경 요약> (한 줄로 간결하게)
    
    본문 (선택)
    - 왜 이런 변경이 필요한지
    - 어떤 부분이 영향을 받는지
    - 테스트 여부 등

     

    커밋 타입 예시

    feat 새로운 기능 추가
    fix 버그 수정
    refactor 코드 리팩토링 (기능 변경 없음)
    chore 빌드, 설정, 문서 등 기타 변경
    docs 문서 수정
    style 코드 스타일 변경 (세미콜론 등)
    test 테스트 추가 또는 수정

     

    예제

    feat: 사용자 로그인 기능 추가
    
    - Firebase Auth 연동
    - 로그인 실패 시 에러 메시지 표시

     

    fix: 로그인 버튼이 여러 번 눌리는 버그 수정
    
    - debounce 처리 추가
    - isLoading 변수로 중복 요청 방지

     

    refactor: HomeController 내 상태 관리 구조 개선
    
    - GetX reactive 변수 정리
    - 사용하지 않는 변수 제거

     

    좋은 커밋 메시지를 써야 하는 이유

     

    나중에 이력이 잘 보임 → 언제 무슨 기능을 넣었는지 추적 쉬움

    팀원이 이해하기 쉬움 → 코드리뷰나 QA 시 이해도 ↑

    롤백 및 디버깅 쉬움 → 문제가 생겼을 때 빠른 원인 파악 가능

    반응형

    댓글

Designed by Tistory.