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

* 학습 내용

- 커밋 메세지 작성 가이드라인

 

 

 

1. 커밋 메세지의 제목과 상세 설명 사이에는 한 줄을 비워둔다

① 번이 커밋 제목, ② 이후부터 커밋 상세 내용이 된다. 

한 줄 비워두기를 권장하는 이유는 특정 명령어가 한 줄 비워진 것을 기준으로 제목과 상세 내용을 구분해서 인식한다고 한다.

 

2. 커밋 메세지 제목 뒤에 온점(.)을 붙이면 안된다.

 

3. 커밋 메세지 제목의 첫 알파벳은 대문자로 작성

 

4. 커밋 메세지의 제목은 명령조로 작성 (ex: Fix it)

 

5. 커밋의 상세 내용은 아래의 내용을 적으면 된다

- 왜 커밋을 했고

- 어떤 문제가 있었고

- 적용한 해결책이 어떤 효과를 가지는지

 

6. 다른 사람이 자신의 코드를 바로 이해할 수 있도록 최대한 친절하게 작성

 

7. 하나의 커밋에는 하나의 수정사항, 하나의 이슈를 해결한 내용만 남기도록 한다.

하나의 커밋이 하나의 사실만을 갖고 있어야 나중에 이해하기 쉽다. 즉 최대한 작은 다위의 변화를 기준으로 커밋하라는 의미.

 

8. 커밋으로 보관된 특정 시점의 전체 코드는 항상 문제없이 실행되는 상태여야 한다.

과거의 커밋은 과거 버전의 프로그램을 사용해야 하거나 과거 커밋을 시작점으로 한 다른 방향의 별도 프로젝트를 시작하거나 아예 그 커밋으로 현재 프로젝트를 리셋할 수 있음.