GitHub 잘 쓰기: 커밋 컨벤션

커밋 컨벤션

깃을 쓰면서 프로젝트를 하면 할수록 깃 컨벤션을 잘 잡고 가야 할 필요성을 느낀다.

커밋 기록이나 PR 기록을 보면 컨벤션을 잘 맞춰서 작성하면 굉장히 깔끔해 보인다.

기본적으로 아래와 같은 형식으로 작성하는게 보통인것 같다.

(깃모지) 커밋 유형: 커밋 내용 요약
ex) feat: xxx 기능 추가

 

아래 사진도 아직 고쳐야할 부분이 보이지만 컨벤션 없이 중구난방으로 작성한 오른쪽 보단

커밋 컨벤션을 지키면서 작성한 왼쪽이 더 깔끔해 보이는것 같다.

커밋 컨벤션 표

이번 프로젝트에서 쓸 커밋 컨벤션을 표로 만든 것이다.

깃모지를 써보았는데 앞의 prefix만 잘 붙여주면 깃모지는 굳이 필요한가 싶다.

팀원 간의 협의가 있어야겠지만 아마 다음 프로젝트 부터는 안쓰는 방향으로 갈것 같다.

✨ feat:	새로운 기능 추가 및 수정	✨ Introduce new features
🐛 fix:	버그 수정	🐛 Fix a bug
📝 docs:	문서 작성 및 수정	📝 Add or uppdate documentation
💄 design:	CSS 개별 추가 및 변경	💄 Add or update documentation
♻️ refactor:	코드 리팩토링	♻️ Refactor code
📦 chore:	패키지 추가, 설정 및 수정	📦 Add or update compiled files or packages
💡comment:	필요한 주석 추가 및 변경	💡 Add or update comments in source code
🚚 rename:	파일 또는 폴더 명을 수정하거나 옮기는 작업	🚚 Move or rename resources (e.g.:files, paths, routes)
🔥 remove:	파일을 삭제하는 작업만 수행한 경우	🔥 Remove code or files