2009. 1. 8. 16:15

SVN 의 Commit Log 기록 규정을 만드는 것은 어떨까 싶습니다.

안녕하세요..
SVN 로그를 보다가 든 생각이 있어서요...
TDD로 진행된 다른 분의 코드를 리뷰하려면 코드 뿐만 아니라
SVN의 로그도 중요한 부분을 담당하지 않을까 싶습니다.
어떤 파일이 추가되었는지 변경되었는지는 SVN tool 등을 통해 이전 소스와 비교해 보면 되겠지만 하나하나 다 보기에는 시간이 많이 걸릴 듯 합니다. 
그래서 로그를 좀 더 체계적으로 남기면, 남길때는 귀찮겠지만 소스 리뷰시 좀 더 편할 것 같습니다.

저의 사내에서는 소스 커밋시 다음과 같은 규정을 두어서 반드시 사용하도록 규정 짓고 있습니다. 
Sample)
(미완)(D-XXXX-X) ~~~~
. 추가 내용 : ~~~
. 개발자 테스트 : ~~~
. SQL을 포함한 경우 DBA의견 : ~~~
. 미 구현 및 Known Bugs : ~~~
. 수정 사항과 연관된 기능(모듈들) : ~~~

강제를 두자는 것은 아니지만 어떤 규칙을 정해서 그 규칙에 따라서 커밋 로그를 남기게 되면
다른 분의 소스 리뷰시 좀 더 쉽게 리뷰가 가능하지 않을까 싶습니다.

[제가 생각한 내용]
(미완 or 완료 "현재 수행하고 있는 todo 커밋 시 진행상태")("현재 진행중인 todo 의 이름") "커밋의 제목" 
- 추가 및 변화의 내용 : 
- 기타(comment) : 


Sample)
(완료)(비디오는 각각 일일 대여요금을 가진다.) Video Class에 rentalFee field 를 추가
- 추가내용 : com.kwlee.video.Video 클래스 생성, 관련 테스트 작성
- 기타(comment) : 잘하고 있는 것일까?--;;

이건 그냥 제가 생각해 본 거고...더 좋은 규칙들을 많이들 가지고 계시지 않을까요..??

저도 지금 행하지 않고 있고..
당장 적용은 힘들겠지만 다음 퀴즈부터라도 해보면 좋지 않을까 하는 생각에서 의견을 남겨봅니다...

감사합니다..


Trackback 0 Comment 8
  1. 기선 2009.01.08 16:37 address edit & del reply

    좋은 의견입니다. 코드 리뷰할 때 유용하겠네요.

    단지.. 완료/미완 구분은 필요 없을 것 같다는 생가이 듭니다. 미완이면 커밋하지 말고 롤백 한담에 다시 구현을 시도하셔야하기 때문에;;

    세 가지로 할까요?

    Task: 고객은 이름이 있다.
    Code: Custom 클래스
    Comment: 고객에 name 속성 추가했는데.. 이름 없는 고객은 없자나요? 그러니까 생성자에 name을 줄까 하는데 아무래도 생각을 너무 많이 한거 같죠? 일단 pass..

    이런식으로 할까요?

    • 기원. 2009.01.09 17:16 신고 address edit & del

      완료/미완은...
      현재 진행하고 있는 task 에 상태를 나타내려고요..
      꼭 한 task를 완료해야 커밋 하는게 아니라고 생각해셔요~~ㅋㅋ

      좋은 규칙이 정해졌음 좋겠네요...^^

  2. dazzi 2009.01.08 19:35 신고 address edit & del reply

    이궁.. 저두 커밋하고 나니깐..
    아.. 이때 커밋하는게 아닌데..
    아.. 이때 했어야 하는데...
    라는 아쉬움이 많이 남더라구요.
    코딩하는것만큼 신경써서 올려야 겠더군요. ㅡㅡㅋ
    어떤 룰이 있는건 좋을것 같아요.

  3. 윤걸 2009.01.08 19:45 address edit & del reply

    작년까지 몸담던 H 사에서 사용하는 로그표준하고 동일하군요... ㅡㅡ;;
    신기해서 뎃글답니다.

    • 기선 2009.01.08 22:11 address edit & del

      윤걸이형 담번 스터디 부턴 참석하시죠? ㅋㅋ

    • 기원. 2009.01.09 17:13 신고 address edit & del

      EKP쪽에 계셨던 이윤걸 선임님 이시군요..
      저는 BPM쪽에 있어서 잘 모르시겠지만요..ㅋㅋ
      이기원이라고 합니다.
      이직하기시 전 이삼일정도 같은팀 이었는데..ㅋㅋ
      암튼 반갑네요...^^

    • mhlee 2009.01.13 13:34 address edit & del

      여기에서 이윤걸 선임과, 이기원주임을 만날줄이야 ㅋ

  4. 카니슈카 2009.01.09 14:12 신고 address edit & del reply

    룰이 있는 것에 대해 대찬성~