Commit Message Guidelines

Git을 사용할 때 적절한 Commit Message를 사용해주어야 관리하기 용이하다!

* Commit Message란 작업 등록 단위인 Commit에 어떤 내용을 작업했는지 작성하는 주석 또는 제목이라 할 수 있다!

 

Commit Message를 간략하고 명확하게 작성하여 1줄에 어떤 작업을 했는지 알 수 있어야한다.

 

물론 정답은 없지만 관리가 잘되고 있다는 대표적인 예시를 살펴보고 참고하여 우리도 관리해보자!

 

바로 Angular Github 레포지토리이다. (https://github.com/angular/angular)

 

Angular에서 제시한 가이드라인은 다음과 같다.

 

출처 : https://github.com/angular/angular/blob/master/CONTRIBUTING.md

어떤 유형의 작업을(type), 어떤 패키지에서(scope), 구체적으로 어떤 일을 하였는가(subject)로 적고 있었다.

 

Type과 scope의 예시를 확인해보자.

출처 : https://github.com/angular/angular/blob/master/CONTRIBUTING.md

출처 : https://github.com/angular/angular/blob/master/CONTRIBUTING.md

이외에 Subject를 적을 때 유의 사항으로는

 

1. 명령조로 적을 것 (ex. A 기능 변경)

2. 마침표 찍지 말것

 

등이 있다. 물론 이건 Angular에서 정한 Commit Message Guideline이기 때문에 참고만하자.

* 정답은 아니고 해답인 셈이다

 

본인 또는 그룹에서 알맞은 Commit Message를 작성하여 관리를 하면 좋을 것 같다.

 

본인도 열심히 Commit 메시지를 써보려고 노력하고 있다.

내 깃헙 ㅎㅎ

 

무튼, Commit Message를 잘 작성해보자. 1일 1커밋도 꾸준히 해보자.