[git] 커밋 가이드라인

 

 

 

 

1. 공백을 제거하자

 

◽️ 공백문자 제거하기

$ git diff --check

 

 

 

2. 각 커밋은 논리적으로 구분되는 Changeset

• 최대한 수정사항을 한 주제로 요약한다.
• 여러가지 이슈에 대한 수정사항을 하나의 커밋에 담지 않는다.
• 한 커밋 당 이슈 하나를 담는다.
• 작업 내용을 분할하고 각 커밋마다 적절한 메세지를 작성한다.
• 여러 번 나누어 커밋하는 것이 다른 동료가 수정한 부분을 확인할 때나 시점을 복원해서 검토할 때 이해하기 쉽다.

 

 

3. 좋은 커밋 메세지 작성하기

• 메시지의 첫 라인에 50자가 넘지 않는 간략한 메시지를 적어 해당 커밋을 요약한다.
• 한 라인은 비우고 그 다음 라인부터 커밋을 자세히 설명한다.

영문 50글자 이하의 간략한 수정 요약

자세한 설명. 영문 72글자 이상이 되면
라인 바꿈을 하고 이어지는 내용을 작성한다.
특정 상황에서는 첫 번째 라인이 이메일
메시지의 제목이 되고 나머지는 메일
내용이 된다. 빈 라인은 본문과 요약을
구별해주기에 중요하다(본문 전체를 생략하지 않는 한).

이어지는 내용도 한 라인 띄우고 쓴다.

  - 목록 표시도 사용할 수 있다.

  - 보통 '-' 나 '*' 표시를 사용해서 목록을 표현하고
    표시 앞에 공백 하나, 각 목록 사이에는 빈 라인
    하나를 넣는데, 이건 상황에 따라 다르다.

 

 

 

---

 

 

출처 및 참고

프로 Git, Scott Chacon, 2014