2011-12-11 2 views
4

changes message 버전 제어 시스템을 작성하는 방법에 대한 지침이나 지침이 있습니까?버전 제어 시스템에 변경 메시지 작성 지침?

확실한 대답은 a brief description of the most important changes으로 보일 수 있지만 실제로는 가장 중요한 변경 사항을 선택하고 이러한 변경 사항의 관련 측면을 간략하게 설명하는 것은 쉽지 않습니다. 특히 개발 초기에는 많은 양의 코드가 추가 될 수 있습니다.

답변

1

을 우리 힘내을 사용하고 네 요구 필드 :

간략한 요약 (Trac에 통합하는 데 사용)

관련 티켓 (커밋 ​​한 줄의 제목)

자세한 보고서

F 필요한 작업

우리의 Git 리포지토리에는 커밋 메시지 양식을 올바르게 작성해야하는 후크가 있습니다. 그렇지 않으면 서버가 커밋을 거부합니다.

이 방법을 사용하면 사람들은 요약 행을보고 무슨 일이 일어 났는지를 알 수 있으며 자세한 보고서는 까다로운 일에 사용할 수 있으며 미래의 작업을 통해 모든 사람들이 아직 어떤 문제가 있는지 확인할 수 있습니다.

1

은 가장 중요한 변경을 선택하고 이러한 변경

당신이 같이 꽉 커밋을 유지하고 특정 변화에 초점을 맞출 경우가 될 수 관련 측면을 설명하기 위해 항상 쉬운 일이 아닙니다 "논리적으로 변경 집합을 분리": "git commit frequency"을 참조하십시오.
(그리고 wrap your comments properly하는 것을 잊지 마세요 :.. 다른 처리 도구 (이메일, 패치 툴)에 따라 주석 줄의 길이가 중요 할 수 있습니다 그것은 프로젝트의 목표에 따라 달라집니다

+0

참. 나는 커밋이 종종 그렇게해야 할 정도로 빡빡하지 않을 때 개발의 초기 단계에 관한 질문을 편집했다. – Peladao

1

내가 과거 시제 동사와 커밋 메시지를 시작하는 것이 도움이 : 는 X 클래스, 추가 기능 Y, 이 롤백 리팩토링 이전 변경 등이 consistant 스타일은 메시지를 통해 읽기 쉽게한다 나중에 다시 보게 될 때 기록됩니다.

버그 추적 시스템에 추적 ID에 대한 참조를 추가하는 것이 유용하므로 나중에 필요할 경우 전체 배경을 조사 할 수 있습니다.