TIL

[TIL] 내일배움캠프_Unity 팀 프로젝트, CommitMessage 규칙

Hwone 2023. 9. 8. 19:54

개인과제 막 끝나니까 팀 프로젝트 시작 ! ,,, 

사전캠프때 유니티로 팀 프로젝트를 하기는 했지만 그때와는 또 색다른 느낌이었다 

이제는 뭔가 진짜 본격적으로 시작하는것 같다 

 

그래서 일단 프로젝트를 시작하기 전에 알아야하거나 원활한 협업을 위해 규칙을 정했다 

 

유니티를 깃허브로 협업할 때 주의할 점 

- 팀원들과 유니티 프로젝트의 버전을 통일해야한다 

- 유니티에서 파일을 binary 방식과 Text 방식을 통해 저장이 되는데 binary 방식으로는 사람이 읽기 어렵기 때문에 충돌이 나면 수정하기 어렵다 그리고 통일되어 있지 않다면 깃허브에서 변경사항을 받을 때 마다 유니티 에디터가 자기 에디터에 맞는 방식으로 강제로 바꿔버리기 때문에 개발자가 수정하지 않은 변경사항이 발생해서 다시 커밋되게 되고 에디터에 의해서 강제로 바뀐 변경사항 내역 때문에 실제 개발자가 변경한 내역을 찾기 어려워진다 

깃허브 규칙 

  • 브랜치 이름 규칙 :  이름 이니셜 - 기능이름 ex ) phw - InputName
  • 커밋 메세지 규칙
TYPE 설명
FIX 버그, 오류해설  ex) [FIX] callback error
ADD Feat 이외의 부수적인 코드 추가/라이브러리 추가/ 새로운 View나 Activity 생성  ex) [ADD] LoginActivity
FEAT  새로운 기능 구현 ex) [FEAT] google login
DEL  쓸모없는 코드 삭제 ex) [DEL] unnecessary import package
REMOVE  파일 삭제 ex) [REMOVE] 중복 파일 삭제
REFACTOR  내부 로직은 변경 하지 않고 기존의 코드 개선하는 리팩토링 시, 세미콜론 줄바꿈 포함 ex) [REFACTOR] MVP architecture to MVVM
CHORE  그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등 ex) [CHORE] delete unnecessary import package
DESIGN  just 화면 ex) [DESIGN] iphone 12 레이아웃 조정
COMMENT  필요한 주석 추가 및 변경 ex) [COMMENT] 메인 뷰컨 주석 추가
DOCS  README나 wiki 등 내용 추가 및 변경  ex) [DOCS] README 내용 추가
TEST  테스트 코드 추가  ex) [TEST] 로그인 토큰 테스트 코드 추가