팀원들과 협업하며 개발을 하게 되면 다들 자기만의 스타일을 가지고 있기 때문에 컨벤션을 잘 정하고 따라야 한다.
깃으로 협업 시 브랜치를 많이 생성하고 삭제하게 되는데, 브랜치의 이름은 일반적으로 어떻게 정하는 것이 좋은지에 대해 알아보자.
브랜치의 목적
해당 브랜치로 무엇을 할 것인지 목적을 먼저 작성하자.
이 브랜치가 기능을 추가하려고 만든 브랜치인지, 버그를 고치려고 만든 브랜치인지 등 브랜치의 목적을 먼저 작성하도록 하자.
자신의 소속 적기
만약 많은 팀 또는 프로젝트들이 있는 환경에서 협업을 한다면 어느 팀의 브랜치인지 적는 것이 브랜치들을 빠르게 분류할 수 있어서 좋다.
항상 Reference Number를 포함하기
이슈 넘버 등의 Reference Number를 같이 작성하여 해당 브랜치가 어떤 것과 관련한 브랜치인지 쉽게 알 수 있게 하자.
적절한 기호 사용하기
feature-#32-signin-ui 이렇게 브랜치 이름을 작성하는 것 보다 기호들을 적절히 사용하여 feature/#32_signin-ui 이런식으로 작성하는 것이 좋다.
최대한 간결하게 작성
브랜치의 이름을 통해 해당 브랜치가 어떠한 브랜치인지 정확하게 알 수 있게 작명하는 것이 좋지만, 너무 장황하게 이름을 정하면 안된다. 최대한 간단하고 명확하게 작성하자.
자신의 이름
해당 브랜치를 누가 생성했는지를 작성하도록 하는 회사도 있고 그렇지 않은 회사도 있다. 그러나 굳이 누가 브랜치를 만들었는지 적지 않아도 쉽게 알 수 있는 방법이 많으므로 이름을 적는 것은 그다지 선호하지 않는다.
팀에 맞게
일반적으로 많이 사용하는 방법을 굳이 따를 필요는 없다. 팀원들과 소통을 통해 컨벤션을 적절히 만들고 잘 따르기만 하면 되므로 각자의 팀에 맞게 컨벤션을 지키자.
Reference
How to Write Great git Branch Names
A Simplified Convention for Naming Branches and Commits in Git
Git Branch Naming Convention
Git Branch Naming Convention: 7 Best Practices to Follow
