1

주제: 소스트리 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)에 의해 마지막으로 수정

문제의 답은 우리 안에 있다.
내면에 귀를 기울여 보자.

2

답글: 소스트리 Commit Log 작성법?

어제 commit할 때, chester님께 log 작성 규칙이 정해져 있는가 여쭈어 보았는데, 자유롭게 작성해도 된다고 하시더군요.

사람이 많아지면 혼선이 생길 것은 확실하니, 여기서 한 번 정하는 것도 괜찮겠습니다 big_smile
어제는 규칙이 없다고 하셔서 변경사항을 * 뒤에 몽땅 적어서 올렸는데, 원래 저는 + - / < > 를 씁니다. (앞에서부터 add / fix / modify / new / remove 의 약자 대신 씁니다 smile ) 제 방법은 쓰기는 편한데, 익숙하지 않은 분들께는 가독성이 떨어지지요  =_=;


p.s.) 그런데 SVN이 전체적으로 revision이 올라가는 것 아니었나요? ;;

"Everything looks different on the other side."

-Ian Malcomm, from Michael Crichton's 'The Jurassic Park'

3

답글: 소스트리 Commit Log 작성법?

inureyes 작성:

어제는 규칙이 없다고 하셔서 변경사항을 * 뒤에 몽땅 적어서 올렸는데, 원래 저는 + - / < > 를 씁니다. (앞에서부터 add / fix / modify / new / remove 의 약자 대신 씁니다 smile ) 제 방법은 쓰기는 편한데, 익숙하지 않은 분들께는 가독성이 떨어지지요  =_=;

그렇게 줄여서 쓰는 것도 괜찮을 것 같습니다. 다만 말씀하신 대로 가독성 문제가 조금 있을 것 같네요.

inureyes 작성:

p.s.) 그런데 SVN이 전체적으로 revision이 올라가는 것 아니었나요? ;;

파일 별로 revision이 올라가고 전체 revision은 maximum revision으로 표시된다는 점을 말씀드린 것인데, 문서를 찾아보니 CVS가 원래 파일별 revision이었고 maximum revision을 보여주는 것이 SVN에서 생긴 거였군요. -_-;;

문제의 답은 우리 안에 있다.
내면에 귀를 기울여 보자.

4

답글: 소스트리 Commit Log 작성법?

daybreaker 작성:
inureyes 작성:

어제는 규칙이 없다고 하셔서 변경사항을 * 뒤에 몽땅 적어서 올렸는데, 원래 저는 + - / < > 를 씁니다. (앞에서부터 add / fix / modify / new / remove 의 약자 대신 씁니다 smile ) 제 방법은 쓰기는 편한데, 익숙하지 않은 분들께는 가독성이 떨어지지요  =_=;

그렇게 줄여서 쓰는 것도 괜찮을 것 같습니다. 다만 말씀하신 대로 가독성 문제가 조금 있을 것 같네요.

음 어떻게 할까요?
두 방법 모두 장단점이 있기는 한데, 어떤 쪽이 나을지 정해야 할 것 같습니다. ㅠ_ㅠ (어느새 r14에요; 대부분은 commit에 문제가 생겨 에러 테스트한 것이기는 하지만...)

전 daybreaker님의 방법을 쓰는 것도 괜찮습니다. 볼 사람들이 많아진다면 역시 규칙을 따로 배우지 않아도 바로 눈에 보이는 쪽이 낫겠죠 smile

"Everything looks different on the other side."

-Ian Malcomm, from Michael Crichton's 'The Jurassic Park'

5

답글: 소스트리 Commit Log 작성법?

inureyes 작성:
daybreaker 작성:
inureyes 작성:

어제는 규칙이 없다고 하셔서 변경사항을 * 뒤에 몽땅 적어서 올렸는데, 원래 저는 + - / < > 를 씁니다. (앞에서부터 add / fix / modify / new / remove 의 약자 대신 씁니다 smile ) 제 방법은 쓰기는 편한데, 익숙하지 않은 분들께는 가독성이 떨어지지요  =_=;

그렇게 줄여서 쓰는 것도 괜찮을 것 같습니다. 다만 말씀하신 대로 가독성 문제가 조금 있을 것 같네요.

음 어떻게 할까요?
두 방법 모두 장단점이 있기는 한데, 어떤 쪽이 나을지 정해야 할 것 같습니다. ㅠ_ㅠ (어느새 r14에요; 대부분은 commit에 문제가 생겨 에러 테스트한 것이기는 하지만...)

전 daybreaker님의 방법을 쓰는 것도 괜찮습니다. 볼 사람들이 많아진다면 역시 규칙을 따로 배우지 않아도 바로 눈에 보이는 쪽이 낫겠죠 smile

네 이 부분은 파파차님이랑 한번 상의를 해서 결정을 해야 될거같네용.
trac, svn 등등 모든것을 파파차님이 작업을 하신것이라서 파파찬님이랑 inureyes , daybreaker 님 이렇게 해서 결정을 하고 나가는 것도 방법일 것 같군요 smile