[SSAFYcial] 2학기 협업을 위한 깃 커밋 메시지 작성 팁

안녕하세요 😀

안드로이드 앱 개발을 공부하고 있는 한상엽입니다.

저번 달 SSAFY 7기 1학기가 종료되고, 곧 2학기가 시작되는데요.

2학기는 팀원들과 함께하는 프로젝트가 주된 과정인 만큼

협업을 위한 깃 커밋 메시지에 관해 말씀드리고자 합니다!

 

---

1️⃣ WHY? - 왜 작성해야 할까?

 

위 이미지는 제가 진행했던 2가지 프로젝트의 커밋 메시지입니다.

전자의 경우엔 당사자는 쉽게 이해할 수 있을지 몰라도, 다른 개발자가 보았을 때

한눈에 파악하기 쉽지 않습니다.

 

하지만 후자와 같이 커밋 메시지의 타입을 정해서 기록하면, 한눈에 보았을 때

협업 시 개발자가 어떤 작업을 했는지 쉽게 확인할 수 있습니다.

또한 가독성이 높아지기 때문에 유지보수에도 도움이 됩니다.

 

2️⃣ HOW? - 어떻게 작성해야 할까?

저는 안드로이드 앱 프로젝트를 진행하면서 대부분

빌드를 구성하거나, UI를 변경하는 코드보다 기능을 추가하거나 삭제, 수정하는 등의 커밋이 훨씬

많다고 느껴, 기능과 관련된 커밋 메시지를 add, remove, update 등으로 세부적으로 나눠

규칙을 정해 사용했습니다.

 

위와 같이 진행하는 프로젝트의 규모나 종류에 맞춰 규칙을 작성하는 것이 좋다고 생각합니다.

2학기 프로젝트를 진행하면서 프론트와 백엔드로 많이 나뉘게 될 텐데,

포지션 별로 규칙을 정해 별도의 표시를 한다던가 하는 방법도 좋은 방법이 될 수 있습니다.

 

가장 중요한 것은 협업 시에 팀원과의 소통을 위한 규칙이므로

팀원과의 논의를 통해 정하는 것이 가장 중요합니다!

 

https://github.com/android/nowinandroid

GitHub - android/nowinandroid: A fully functional Android app built entirely with Kotlin and Jetpack Compose

또한 위의 안드로이드 공식 깃허브의 커밋 메시지를 보면

Remove, Update 등의 커밋 메시지 규칙을 사용하는 것을 알 수 있는데요.

 

자신의 기술 스택을 사용하는 공식 사이트, 유명한 프로젝트의 커밋 메시지 규칙을 참고하는 것도

좋은 방법이 될 수 있습니다!

 

---

이렇게 협업을 위한 깃 커밋 메시지에 대해 간단하게 알아보았습니다.

1학기 동안 고생한 SSAFY 7기의 남은 2학기도 응원합니다! 😎