소스코드 관리 시스템(SCM)에 로그 제대로 남기기

소스코드 관리 시스템(Source code Management System)에 사용할 경우 소스코드를 수정하고
변경사항을 SCM 서버에 올릴때(Commit, checkin.. )에는 로그를 남길 수 있다.

로그를 남기지 않아도 크게 문제 없이 변경사항을 반영할 수 있지만,
여러 사람이 작업을 하는 경우에는 로그를 남기는것이 변경사항을 파악하는데 도움이 된다.

그동안 로그를 남길때 어떤 규칙에 의해서 남기는 것이 아니라 "어떤 것들이 변경되었음" 이라든지
"이래저래 해서 수정함" 과 같은 로그를 남겼는데 나중에 뭔가 일이 터져서 로그를 살펴보면
로그만으로는 소스코드의 변경내용을 한눈에 파악하기 힘든 상황을 경험했다.

CodeCraft 책을 읽다보니 로그 작성에 참고하면 괜찮을 것 같은 내용이 담겨 있기에 정리~

CheckIn/ CheckOut 로그 작성

• 수정로그 전체를 빠르게 훑어 볼수 있도록 짧게
• 잘못된 정보를 제공하는 쓸데없는 로그가 되지 않도록 정확하게
• diff를 이용해서 파일 내용을 비교하지 않아도 파일안에 무슨일이 일어났는지 전부 볼 수 있도록 완전하게
  

어떻게 바뀌었는지를 기록하지 말고 무엇이 왜 바뀌었는지를 기록해라.
어떻게 바뀌었는지는 리비전을 비교해보면 쉽게 파악할 수 있다.

    - CodeCraft 뛰어난 코드 작성을 위한 설계 지침, 2007, 피트 구들리프, 한빛미디어