[Git/GitHub] 커밋 가이드

Git / GitHub 를 복기해보고자 Codeit 온라인 강좌를 듣는 중이다.

강의 요약노트를 너무 잘 만들어주시고
세세하게 설명해주셔서 만족도 200% !!

그 중 커밋 메시지 작성 가이드라인에 대한 내용이 좋아서 옮겨두고 계속 참고하려고 한다.

커밋 메시지 작성 가이드라인

1. 커밋 메시지의 제목과 상세 설명 사이에는 한 줄을 비워둘 것. (GitHub 권장이기도 함)
2. 커밋 메시지의 제목 뒤에 온점(.)을 붙이지 말 것.
3. 커밋 메시지의 제목의 첫 번째 알파벳은 대문자로 작성.
4. 커밋 메시지의 제목은 명령조로 작성.(Fix it / Fixed it / Fixes it)
5. 커밋에 포함되면 좋은 상세 내용

• 왜 커밋을 했는지?
• 어떤 문제가 있었는지?
• 적용한 해결책이 어떤 효과를 가지는지

6. 다른 사람들이 자신의 코드를 바로 이해할 수 있다고 가정하지 말고 최대한 친절하게 작성!!

커밋할 때 알아야할 가이드라인

1. 하나의 커밋에는 하나의 수정사항, 하나의 이슈(issue)를 해결한 내용만 남기도록 하세요. 다양하게 수정을 하고나서 하나의 커밋으로 남기는 것은 좋지 않습니다. 하나의 커밋이 하나의 사실만을 갖고 있어야 나중에 이해하기 쉽습니다.

2. 현재 프로젝트 디렉토리의 상태가 그 내부의 전체 코드를 실행했을 때 에러가 발생하지 않는 상태인 경우에만 커밋을 하도록 하세요. 나중에 동료 개발자가 특정 커밋의 코드로 실행했을 때 에러가 발생한다면 혼란을 줄 수 있습니다.

3. 이 외에도 나중에 다시 봤을 때 이해하는데 어려움이 없도록, 동료 개발자와 협업하는 데 방해가 되지 않도록 커밋을 남기고, 그때마다 커밋 메시지를 잘 작성하는 것이 중요합니다.