녕의 학습 기록
[프리코스 2주차] 커밋 메세지의 제목 작성하기 본문
1주차의 공통 피드백에는 다음 링크와 함께 커밋 메세지를 의미있게 작성하라는 내용이 있었다.
https://meetup.nhncloud.com/posts/106
링크 속 내용을 쭉 정독하고 가장 고민 된 부분은
그래서 제목을 명령조로 사용할 것인가?였다.
영어 기준으로 좋은 커밋 메세지는 제목을 명령조로 작성한다고 한다.
예를 들어 A메서드를 변경했으면 -> Change A method 이렇게 말이다.
근데 한국어로 작성하면 커밋 메세지의 제목이 'A메서드를 변경하라' 가 되어버린다.
작성하면서도 이게 맞나하는 생각과 함께 나도 영어로 커밋 메세지를 작성해야하나 싶기도 했다.
하지만 커밋 메세지를 작성하는 사람과 읽는 사람 모두가 한국인일 것이기 때문에 한국어를 사용하기로 했다.
그렇다면, 한국어로 커밋 메세지의 제목은 어떻게 작성할 것인가?
A 메서드를 변경하라
A 메서드를 변경
A 메서드 변경
A 메서드를 변경했다
A 메서드를 변경함
A 메서드를 변경한다
...
굳이 만들자면 정말 무수한 가지수가 나올 것이다.
이중에 나는 현재형('A메서드를 변경한다')을 선택했다.
다음의 두가지 이유가 있다.
- 가장 읽기 편안하다
- 영문 기준 좋은 커밋메세지를 작성하는 방법 중 "If applied, this commit will {제목}" 을 준수해보라는 내용이 있다.
이 내용에 따랐을 때 "If applied, this commit will A메서드를 변경한다"가 가장 어울렸다.
사실 그전까지는 제목 앞의 feat, docs, fix 이런 키워드들만 신경을 썼지, 제목을 어떻게 작성할지에 대해서는
깊게 생각해보지 않았었다. 하지만 이번 고민을 통해서 커밋 메세지의 제목조차도 좋은 프로그래밍에
기여할 수 있다는 것을 깨달았다.
'대외활동 > 우아한테크코스 7기' 카테고리의 다른 글
레벨 1 - 출석 회고 (4) | 2025.03.03 |
---|---|
레벨 1 - 로또 회고 (1) | 2025.02.20 |
우아한테크코스 7기 웹 백엔드 최종 합격 후기 (4) | 2024.12.30 |
우테코 7기 1차 합격 및 최종 코딩테스트 후기 (4) | 2024.12.17 |
[프리코스 2주차] gitignore 분석하기 (0) | 2024.10.24 |