CVS나 Subverion의 설명(Comment)을 어떻게 달 것인가?

CVS나 Subversion을 사용하여 소스를 커밋할 때, 개발자들의 각각의 취향에 따라서 설명(Annotation, Comment)를 취향대로 달게 됩니다. 어떤 분은 아무 내용없이 "."만 입력하시는 분도 있으며, 어떤 분은 "버그 수정"만 입력하시는 분도 있고 어떤 분은 "A라는 기능 추가와 B라는 기능의 부분 수정"이라는 추상적 기록을 남기시는 분도 있고 어떤 분은 "1. A의 기능 추가, 2. 어떤 기능 수정..." 등등 상세하게 기록하는 분들도 있습니다.

The Red Bit Blue Bit Blog의 "Subversion Check-in Comment - Great Practices" by John Uhri에 이러한 커밋 시 설명을 어떻게 달면 좋을 지에 대한 글이 올라왔는데요. 요약해서 정리하면 다음과 같습니다.

1. 각각의 설명을 Added, Changed, Fixed, Deleted 네 가지의 카테고리로 나누어서 정리합니다.
   
2. 각각의 설명이 트렉의 티켓이나 버그질라의 버그번호 등과 관련이 있는 경우 해당하는 링크를 함께 표기합니다.
   

이렇게 함으로써 얻는 효과는 큰 카테고리를 설정함으로 커밋된 내용이 어떤 내용인지를 한 번에 알 수 있게 해줍니다. 큰 카테고리 아래에 세부 사항을 적어야 하므로 기존 보다 좀 더 상세하게 적는 효과도 얻게 될 수 있습니다.

커밋 설명(Comment)를 어떻게 표기할 지 고민된다면 위의 방식을 도입해보는 것도 좋은 시도가 될 수 있을 것 같습니다. "버그 수정", "기능추가"로 끝나는 것보다 훨씬 낳겠죠? ^^

출처:

• Subversion Check-in Comment - Great Practices" by John Uhri
  
• Subversion Check-in Comment Example