좋은 커밋 메세지를 작성하는 방법

공부 계기 🧚

엊그제 좋은 커밋에 대한 글을 읽었다. '리드미 작성법'이 있는 건 알고 있었지만, 커밋에도 작성법이 있는 건 처음 알았다. 앞으로 협업을 하게 될 것을 대비하여 좋은 커밋 작성법을 구체적으로 정리한다.

 

좋은 커밋 메세지를 작성하는 방법 🔖

1. 커밋의 종류를 명시한다

- feat : 어떤 특정 어플리케이션에 더할 새로운 feature

- fix : 어떤 오류 해결(fix)

- style: 스타일과 연관된 feature나 업데이트

- refactor: 코드 베이스의 특정 부분을 재정렬(refactoring)

- test: 테스트와 관련된 모든 것

- docs: 문서화에 관한 모든 것

- chore: 정규 코드 유지 보수

 

2. 제목과 본문 사이 빈칸 한 줄을 띄워 구분한다

 

3. 커밋 메세지는 공백 오류를 포함하지 않는다

 

4. 불필요한 점을 넣지 않는다

 

5. 제목 행을 마침표(.)로 끝맺지 않는다

 

6. 영어일 경우, 제목 행과 매 문단의 시작을 대문자로 한다

 

7. 제목 행에는 명령어를 사용한다

 

8. 본문 영역은 변경 사항과 그 이유를 작성한다

 

9. 검토자들이 본래 문제가 무엇인지 이해하고 있을 것이라 가정하지 말고 그것을 더해 적는다

 

10. 본인의 코드가 설명 없이도 괜찮다고 생각하지 않는다

 

11. 소속되어 있는 팀의 정해진 커밋 규칙을 따른다

 

 

결론 🍮

좋은 커밋 메세지는 작성자가 얼마나 좋은 협력자인지를 보여준다. 지금까진 그날 그날 공부했던 것을 작성했는데, 협업을 한다는 관점으로 커밋 작성에 신경 써야 겠다.

 

이런게 웃긴 걸 보면 나도 제법 개발자