GitHub 커밋 메시지 컨벤션 - 더 나은 협업을 위한 최소한의 예의

GitHub 커밋 메시지 컨벤션 - 더 나은 협업을 위한 최소한의 예의

 

 

프로젝트의 품질을 높이고 개발 팀 간의 협업을 강화하기 위한 다양한 커밋 메시지 컨벤션을 활용하는 방법에 대해  알려드리겠습니다.

 

 

다양한 커밋 메시지 컨벤션

 

 

1. build: 빌드 시스템 및 외부 종속성 변경

시스템 또는 외부 종속성에 영향을 주는 변경사항은 build로 명시하여 관리합니다.

 

예시 코드로 확인하기

git commit -m "build: npm 패키지 업데이트"

 

 

2. ci: CI 구성 파일 및 스크립트 변경

CI 구성 파일이나 스크립트를 수정할 경우, ci를 사용하여 변경 내용을 명시합니다.

 

예시 코드로 확인하기

git commit -m "ci: GitHub Actions 스크립트 업데이트"

 

 

3. chore: 기타 작업 및 설정 변경

패키지 매니저 설정과 같은 코드 수정 없이 설정을 변경하는 경우 chore를 활용합니다.

 

예시 코드로 확인하기

git commit -m "chore: ESLint 설정 변경"

 

 

GitHub Readme 마크다운 사용법 (체크리스트, 이모티콘, 코드블럭, 폰트, 링크)

 

4. docs: 문서의 추가 또는 수정

프로젝트의 문서를 추가하거나 수정할 때는 docs를 사용하여 명시적으로 표현합니다.

 

예시 코드로 확인하기

git commit -m "docs: API 문서 업데이트"

 

 

5. feat: 새로운 기능의 도입

새로운 기능을 추가할 때는 feat을 사용하여 변경사항을 빠르게 전달합니다.

 

예시 코드로 확인하기

git commit -m "feat: 사용자 등록 기능 추가"

 

 

 

6. fix: 버그 수정

프로젝트에서 발생한 버그를 수정할 때는 fix를 사용하여 명확하게 기록합니다.

 

예시 코드로 확인하기

git commit -m "fix: 검색 결과 정렬 오류 수정"

 

 

7. perf: 성능 개선

코드의 성능을 개선하는 경우 perf를 사용하여 변경사항을 기록합니다.

 

예시 코드로 확인하기

git commit -m "perf: 데이터 캐싱 로직 개선"

 

 

8. refactor: 코드 리팩토링

기능 추가나 버그 수정이 아닌 코드의 개선을 목적으로 하는 경우 refactor를 활용합니다.

 

예시 코드로 확인하기

git commit -m "refactor: 중복 코드 제거 및 가독성 향상"

 

 

9. style: 코드 스타일 변경 및 UI 개선

코드의 의미에는 영향을 주지 않으면서 코드 스타일이나 UI를 개선할 때는 style을 활용합니다.

 

예시 코드로 확인하기

git commit -m "style: 로그인 버튼 스타일 조정"

 

 

 

10. test: 테스트 코드 작성 또는 수정

테스트를 추가하거나 수정할 때는 test를 사용하여 변경사항을 명시합니다.

 

예시 코드로 확인하기

git commit -m "test: 사용자 인증 로직 테스트 추가"

 

 

11. revert: 작업 되돌리기

이전 작업을 되돌릴 때는 revert를 사용하여 변경 이력을 관리합니다.

 

예시 코드로 확인하기

git commit -m "revert: 이전 커밋 되돌리기"

 

 

커밋 메시지의 중요성과 협업의 원활함

 

다양한 커밋 메시지 컨벤션을 활용하면 프로젝트의 추적성이 향상되고, 개발 팀 간의 소통이 원활해집니다. 명확하고 일관된 커밋 메시지는 프로젝트의 품질을 향상시키고, 코드의 유지보수를 용이하게 만듭니다.

 

좋은 프로젝트는 명확한 커밋 메시지로부터 시작됩니다. 이러한 컨벤션을 통해 협업이 더욱 원활하게 이루어질 수 있습니다.

 

▼ 아래 글도 읽어보세요! ▼

 

GitHub Readme 마크다운 사용법 (체크리스트, 이모티콘, 코드블럭, 폰트, 링크)

 

Git, 실수로 삭제한 파일 복구하는 방법