git commit message convention 깃 커밋 메세지 컨벤션

프로그래머스 AI dev course를 수강하면서 깃과 깃허브를 조금씩 경험하고 있는 중이다.

아직 팀 협업은 거의 하지 않고, 개인이 과제를 깃헙에 올리고 있다.

 

numpy, pandas같은 주제를 수업하는 동안은 선생님이 수업 material을 올린 repository를 fork한 다음, 

내 계정 repository에서 새 branch를 만들어서 거기에 내가 한 과제를 올리고 pull request를 하는 식을 과젤르 제출하였다.

 

이번에 제출한 월말 과제는 내 repository에 결과물을 올리고, 

강사님 계정의 discussion 탭에 글을 써서 내 repository 링크를 다는 식으로 제출하였다.

 

그런데 정신없이 과제를 제출하고, 잠시 짬이 나서 내 깃헙을 보니

이렇게 되어 있더라.

 

남이 봐도 뭘 했다는 것인지 모르고, 조금만 시간이 지나도 내가 한 걸 내가 봐도 뭔 소린 줄 모르게 적혀진 커밋 메세지.

잘쓴 메세지가 아니란 건 알겠다.

그런데 정신없이 시간이 쫓기는데 항상 커밋할 때 '아... 뭐라 쓰지?' 라고 고민하게 되고, 빨리 커밋하고 다음 작업을 해야된다고 생각하다 보니 이렇게 되어 버리고 만다.

 

그래서 일단은 다른 사람들이 쓰는 깃 커밋 메세지 컨벤션을 따라 하면서 습관을 들이려고 한다.

 

오픈 소스 프로젝트들은 다들 나름의 컨벤션이 있고, 기여자들에게 이를 따르라고 한다.

다음은 pandas 프로젝트의 컨벤션.

https://pandas.pydata.org/pandas-docs/stable/development/contributing.html

 

 

이에 따르면, 내 커밋 메세지는 

BUG : 그래프 오버레이 문제 해결

 이렇게 썼어야 했다.

 

앞으로 당분간은 깃허브에 올릴 때 이 포스트를 띄워놓고 따라쓰며 몸에 익히려 노력해봐야겠다.