좋은 커밋 메시지 — 미래의 나에게
3주 뒤의 내가 읽고 이해할 한 줄. 잘 쓰는 요령은 의외로 간단해요.
3주 뒤, 가게 가격이 왜 바뀌었는지 다시 찾아야 할 일이 생겨요. 그때 장부에 "수정"이라고만 적혀 있으면? 미래의 나는 한숨을 쉽니다. 커밋 메시지는 미래의 나에게 보내는 쪽지예요.
📚 「좋은 커밋 메시지 — 미래의 나에게」 레슨 내용 전체 텍스트로 훑어보기
3주 뒤, 가게 가격이 왜 바뀌었는지 다시 찾아야 할 일이 생겨요. 그때 장부에 "수정"이라고만 적혀 있으면? 미래의 나는 한숨을 쉽니다. 커밋 메시지는 미래의 나에게 보내는 쪽지예요.
좋은 커밋 메시지에는 두 가지가 들어가요.
· 왜 바꿨나 — "원가가 올라서"
'무엇을'은 코드를 보면 어느 정도 알 수 있어요. 하지만 '왜'는 내 머릿속에만 있어요. 그래서 메시지에 '왜'를 남기는 게 특히 귀해요. 3주 뒤의 나는 코드는 읽을 수 있어도, 그때의 이유까지는 기억 못 하거든요.
"업데이트"
"asdf"
"고침2 진짜최종"
무엇을·왜 둘 다 없음. 미래의 내가 커밋을 하나하나 열어봐야 해요.
"품절 표시 기능 추가 — 재고 0이면 회색"
"장바구니 합계 오류 수정 (배송비 누락)"
한 줄만 봐도 무엇을·왜가 보임.
먼저 흔한 실수를 손으로 겪어봐요. 메뉴판 파일을 고쳤다 치고, 성의 없는 메시지로 커밋해볼게요.
git add menu.html — 방금 고친 파일을 스테이지에 올려요git commit -m "수정" — 성의 없는 메시지로 커밋 — 3주 뒤에 후회할 한 줄이번엔 영업시간을 바꿨다고 해볼게요. 무엇을 + 왜가 담긴 메시지로 커밋해봐요.
git add menu.html — 바뀐 파일을 올려요git commit -m "영업시간 21시→20시로 단축 (재료 소진 빨라짐)" — 무엇을·왜가 한 줄에 담긴 좋은 메시지커밋 메시지는 git commit 뒤에 어떤 옵션으로 붙일까요? 한 줄짜리 메시지를 바로 다는 그 옵션이에요.
-m이에요. m은 message의 머리글자. 뒤에 따옴표로 감싼 한 줄이 그대로 장부에 남는 메시지가 돼요.이번엔 명령이 아니라 메시지 자체를 연습해요. 반찬 사진을 새로 올렸어요. 아래 '수정' 자리에 들어갈 무엇을+왜가 담긴 한 줄을 적어보세요. (예: 어떤 반찬 사진을, 왜 바꿨는지)
지금까지 남긴 커밋들을 git log --oneline으로 펼쳐볼 거예요. 화면에 무엇이 줄줄이 보일까요?
git log --oneline은 커밋마다 짧은 코드 + 내가 적은 메시지를 최신순으로 한 줄씩 보여줘요. 이게 바로 미래의 내가 펼칠 장부예요. 그래서 메시지 한 줄이 그렇게 중요한 거죠.실제로 장부를 펼쳐봐요. 방금 남긴 좋은 커밋과 나쁜 커밋이 나란히 보일 거예요.
git log --oneline — 지금까지의 커밋을 한 줄씩 펼쳐봐요