원격 저장소의 분기를 문서화하려면 어떻게해야합니까?

Question

브랜치에서 수행중인 작업에 대한 간단한 설명/근거를 추가하고 싶습니다. 문장 하나 또는 두 개 뿐이지 만 지사 이름을 통해 전달할 수있는 것보다 훨씬 많습니다. 불행히도, 나는 이것을 달성하기위한 명확한 방법을 찾을 수 없었습니다.

git branch --edit-description은 repo config에 저장되어 있기 때문에 푸시 할 수 없습니다. 다른 사람이 읽을 수 없다면 문서는별로 좋지 않습니다. 두 가지 대안이 마음에 들지만 둘 다 의미론에 문제가 있습니다.

첫 번째는 저장소 내용에 문서를 저장하는 것입니다. 이 옵션은 저장소 내용을 "오염"시키고 부작용이 있으므로 (특히 병합 할 때) 두 가지 모두 매력적이지 않습니다.

다른 하나는 변경없이 커밋을 생성하려면 git commit --allow-empty을 사용하는 것입니다. 이것은 여전히 ​​커밋의 의미를 깨뜨리지 만 적어도 저장소에서 메타 데이터를 유지합니다.

현재 빈 커밋 기술을 사용하려고하지만 다른 대안이 있습니까? 내가 간과하고있는 다른 문제들?

이 작업을 수행하는 일반적인 방법은 무엇입니까?

Answer 1

나는

이 리베이스하지 않을 지점입니다 가정하면, 그때 당신은 유사한 이름을 가진 주석 태그를 만들 수 있습니다 ...이 모든 옵션을 더 잘하지만 모르겠어요 초기 분기 지점에서 분기를 작성한 다음 태그 설명 메시지를 사용하여 분기를 설명하십시오.

그래서 대신

git checkout -b my_feature SOME_START_POINT 

당신은,이 정보는 분기 자체와 연관되지 않을 것 등

git tag -m "Startpoint of the my_feature branch which is for ...." MY_FEATURE SOME_START_POINT 
git branch my_feature MY_FEATURE 

또는 my_feature_start_point 같은 다른 명명 체계를 가질 것 그러나 인간이 필요에 따라 알아낼 수있는 방식으로 상관 될 수 있습니다.