겉핥기로 시작하는 Git -commit 보충편-
commit
보충편으로 돌아왔습니다! 이번 글에서 소개하는 내용은 제가 개인적으로 선호하는 방법들입니다. 이번 글은 이런 식으로 커밋을 할 수도 있구나하는 참조 정도로만 읽어주세요.
겉핥기로 시작하는 Git -commit편-에서 몇가지 권장사항을 소개 드렸지만 Git
을 막 가르쳐서 같이 프로젝트를 진행하게 되면 규칙들이 잘 지켜지지 않고, 메세지가 명확하지 않은 경우가 더 많습니다. 결국 작업 내용을 확인해야지 해당 commit
이 뭘 위한 것이었는지 알 수 있는 경우도 있었습니다.
그래서 방법이 없을까 찾던 중 prefix
를 사용하는 방법을 발견해서 저희 팀에 맞게 수정을 해서 사용했습니다.
- [Add] 신규 파일 추가
- [Update] 업데이트
- [Refac] 코드를 리팩토링
- [Fix]
- [Mod]잘못된 링크 정보 변경, 필요한 모듈 추가 및 삭제
- [Remove] 파일 제거
- [Style] 디자인 관련 변경사항
- [Release] 배포
- [Merge] branch를 머지
위와 같은 prefix
를 메세지에 달고 내용을 작성했습니다. 저희 팀의 경험으로는 꽤 좋은 솔루션이 되어 주었습니다. commit
단위를 고민할때 한번에 여러가지 prefix
가 달리지 않게 파일들을 선택해서 commit
을 진행했고, 메세지의 제목만으로 작업의 흐름을 파악할 수 있었습니다.
commit
메세지에서 제목은 전체적인 작업의 흐름을 보여주고 본문은 필요할 경우 구체적인 내용을 적어 주어야합니다. 본문을 작성할 때는 어떻게
보다 무엇을
, 왜
가 더 중요합니다. 어떻게
는 코드를 보면 됩니다. 로직이 어떻게 바뀌었는지는 코드를 분석해서 충분히 알 수 있는 내용입니다. 하지만 무엇을
과 왜
는 행간을 읽어야 하고 파악이 쉽지 않습니다. 원할한 의사소통을 위해선 명시적으로 무엇
, 왜
에 초점을 맞춰 작성해주시는 편이 좋습니다.
겉핥기로 시작하는 Git
시리즈는 Git bash
를 사용하는 것으로 전제로 작성 된 글입니다. 이김에 CLI
에 익숙해져 보세요!!