[Git] 협업 프로젝트 관리 전 세워야 할 GIT 규칙

참고

https://www.hanbit.co.kr/store/books/look.php?p_code=B8463790401 

만들면서 배우는 Git+GitHub 입문

 

1. 커밋 단위

 

커밋의 내용을 최소 단위Atomic로 유지하기

다음과 같은 규칙들을 지키는 것이 좋다.

 

• 커밋 하나는 하나의 의도마을 가져야 한다. 한번에 여러 파일을 수정하더라도 그 의도는 단 하나여야 한다. 버그 수정이든 새로운 기능 추가이든.
• 파일을 하나만 수정하더라도 두 개 이상의 의도가 있다면 하지 말아야 한다. 버그 수정과 새 기능 추가를 동시에 하지 않아야 한다. 쉽지 않겠습니다. 선생님...

 

2. 커밋 메시지 작성 규칙

 

[category] - [simple message]

[detailed description]

 

[category] : 커밋의 성격이 무엇인지 한번에 알 수 있는 단어로 작성한다. 가능하면 짧고 명확하게. 

 

[category] 작성 규칙 예

(이름) - (설명)

fix - 잘못된 부분 수정

add - 기능 추가

mod - 코드 수정

rm - 기능 삭제

 

전 회사에서는 저 카테고리에 지라 이슈 번호를 넣었었다.

 

[message] : 해당 커밋에 대한 간단한 한 줄 설명 작성. 영문 기준 70자 정도. 일반적인 터미널에 보이는 글자 수를 고려한 것

 

[detailed description] : 커밋의 자세한 내용을 기술. 하지만 몇 가지 사항을 꼭 지켜서 작성할 것을 권장함.

왜 커밋을 했는지 설명함

버그 수정의 경우 원래 어떤 문제가 있었는지 설명

사용 중인 이슈 트래커가 있다면 해당 이슈의 하이퍼링크를 포함해야 한다.

 

이런 규칙들을 염두에 두면서 커밋 메시지를 작성하면 커밋만 보고도 많은 정보를 얻고, 새로 협업에 참가하는 사람이 이전의 커밋 로그만을 보고도 전체적인 프로젝트 흐름을 이해하고 현재 작업에 참여하는 것이 더 쉬워짐.

 

참고하기 : https://wiki.openstack.org/wiki/GitCommitMessages

GitCommitMessages - OpenStack

 

3. 브랜치 이름 작성 규칙

 

새로운 브랜치를 만들 때 어떻게 이름을 지을지를 협업자들 사이에 공유한다면, 브랜치 이름만을 보고서 어떤 목적으로 브랜치를 만들었는지를 바로 알 수 있다.

브랜치 또한 몇 가지 카테고리를 만들어서 분류하는 것이 좋다. 짧으면서 쉽게 구별할 수 있고 협업 흐름에서 권장하는 브랜칭 방식에 따라서 이름을 짓는 것이 좋다.

 

브랜치 이름 작성 규칙의 예

(이름) - (설명)

new - 새 기능 추가가 목적인 브랜치

test - 무언가를 테스트하는 브랜치(새 라이브러리, 배포 한경, 실험 등)

bug - 버그 수정이 목적인 브랜치

 

이런 카테고리 이름을 접두어로 사용하면서, 그 뒤에 브랜치 이름을 붙인다. 이때 구분자로는 슬래시(/) 기호를 사용하는 것을 권장한다. 이런 규칙으로 다음과 같은 브랜치 이름을 만들 수 있다.

 

new/feat-foo

new/feat-bar

bug/critical-thing

test/awesome-new-library

 

이렇게 하면 git branch - list 명령을 실행해 특정 카테고리 브랜치만 찾아보기 쉬워진다.

SourceTree에서는 브랜치를 폴더처럼 관리할 수 있다.

 

브랜치 이름을 지을 때 하지 말아야 할 것들도 있다.

• 사람이 한 번에 알아볼 수 없는 이름(예: 숫자로만 된 이름)
• 너무 긴 설명조의 이름

 

4. 태그와 버전 이름 작성 규칙

 

버전 이름은 '유의적 버전(https://semver.org/lang/ko/)' 웹 페이지를 참고해 버전 이름을 커밋에 올바르게 태깅하는 것만으로도 많은 정보를 제공한다.

 

x.y.z 유의적 버전 간단 설명

x는 기존과 호완이 되지 않는 변경이 발생할 때 증가시킨다.

y는 기존과 호완이 되며, 새로운 기능이 추가될 때 증가시킨다.

z는 기존과 호완이 되며, 버그 수정 등이 될 때 증가시킨다.