주제: 소스트리 Commit Log 작성법?
여기에 쓰기는 조금 생뚱맞은 것 같지만 '제안하기' 성격이라서 여기다 씁니다.
아직은 커미터가 거의 없기 때문에 별로 상관이 없지만, 향후 커미터들이 많아지게 된다면 커밋 로그가 매우 중요해집니다.
제가 동아리 프로젝트로 진행했던 oco도 그렇고, 제가 개인적으로 시스템 프로그래밍 숙제를 하면서 svn을 쓸 때도 그렇고 커밋 로그를 다음과 같이 정리해서 쓰고 있습니다. MetaBBS도 그런 방식으로 가려고 하고 있으나 제가 손을 못대고 있는 관계로..-_-;
(http://svn.daybreaker.info/view/oco 를 참고하세요.)
Add, Fix, Modify, New, Remove로 주요 변경 내용을 쓰는 겄인데, *+공백 뒤에 앞의 네 단어 중 하나를 쓰고 콜론+공백을 붙여서 뒤에 로그를 적습니다. 이때 가능하다면 어느 파일의 어느 함수가 수정되었는지도 같이 써주지요. (사실 SVN은 CVS와 달리 파일 단위로 revision이 올라가게 되어 있어서 굳이 이렇게 하지 않아도 되지만 수정된 부분을 찾아볼 때 훨씬 편합니다)
(경우에 따라서는 Add와 New의 구분이 헷갈리기도 해서, 대충 Add로 통일하거나 New로 통일해도 될 것 같네요.)
예:
* Add: free_joblist() in jobs.c
* Modify: free_joblist()'s algorith
* Fix: segmentation fault in parse_command()
...
이렇게 하면 커밋 로그가 한 줄로 붙어나와도 * 때문에 비교적 쉽게 구분이 되고, 어디가 수정되었는지 찾기 쉽습니다.
그리고, 한 번에 워낙 여러 부분을 수정한 경우 전체적으로 어떤 것을 수정하기 위한 것이었는지를 맨 앞줄에 간단히 써주는 것도 좋겠지요.
음.. 이것보다 더 좋은 방법도 있을 것 같은데, 아이디어를 모아보았으면 합니다.
daybreaker (2006-04-14 03:54:30)에 의해 마지막으로 수정
내면에 귀를 기울여 보자.