[Github, 협업] 좋은 commit message 작성하기😊 (++gitmoji)

저는 요즘 개발을 하면서 팀원과 협업이 굉장히 중요하다고 느끼고 있습니다
그리고 저번 글에서 PR, Fork, Issue 사용법에 대해서 알아봤으니
오늘은 좋은 commit Message 대해서 다뤄보겠습니다

---

⭐ 커밋 메시지 작성하기

Feat: "팝업 구현" = 제목

date: 2024.10.22 = 날짜 (optional)


1. 팝업 아이콘
2. 팝업창       = 본문
3. 팝업 기능


Resolves: #39 = 꼬리말 (해결된 이슈의 이슈코드)

Related to: #33, #34 = 꼬리말 (관련된 이슈의 이슈코드)

커밋 메시지는 제목, 본문, 꼬리말로 나눌 수 있는데 설명이 부족하지 않다면 제목만을 적어도 됩니다
하지만 어떤 변경사항이 있는지 설명이 필요하다면 본문과 꼬리말을 추가할 수 있습니다

---

🎯 제목

• 제목을 쓸 때 제목 태그: 작업내용 형식으로 작성합니다
• 제목에는 마침표를 찍지 않습니다
• 명령어 형식으로 작성합니다
• 첫 글자는 대문자로 작성합니다
• 50자 이내로 작성해야 합니다

제목 태그들

• Feat: 새로운 기능을 추가할 경우
• Fix: 버그를 고친 경우
• Design: CSS 등 사용자 UI 디자인 변경
• !BREAKING CHANGE: 커다란 API 변경의 경우
• !HOTFIX: 급하게 치명적인 버그를 고쳐야 하는 경우
• Style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
• Refactor: 프로덕션 코드 리팩토링
• Comment: 필요한 주석 추가 및 변경
• Docs: 문서를 수정한 경우
• Test: 테스트 추가, 테스트 리팩토링 (프로덕션 코드 변경 X)
• Chore: 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우 (프로덕션 코드 변경 X)
• Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
• Remove: 파일을 삭제하는 작업만 수행한 경우

그리고 추가로 제목에 gitmoji 페이지에 있는 상황에 알맞는 이모지를 사용하면 더 좋은 제목을 작성할 수 있을 것이다

https://gitmoji.dev/

gitmoji

---

🎯 본문

• 선택사항이기 때문에 생략 가능합니다
• 부연설명이 필요하거나 커밋의 이유를 설명할 때 작성합니다
• 72자 안에 작성해야 합니다
• 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성합니다

---

🎯꼬리말

• 선택사항이기 때문에 생략 가능합니다
• 유형: #이슈번호 형식으로 작성합니다
• issue tracker id를 작성할 때 사용합니다

꼬리말 태그들

• Fixes: 이슈 수정 중 (아직 해결되지 않은 경우)
• Resolves: 이슈를 해결했을 때 사용
• Ref: 참고할 이슈가 있을 때 사용
• Related to: 해당 커밋에 관련된 이슈 번호 (아직 해결되지 않은 경우)

---

글을 마치며 

이렇게 좋은 commit 메시지를 살펴보고 설명해보았는데요 여러분들도 다른 사람과 협업을 하면서
이 글에서 배운 것을 활용하여 좋은 커밋 메시지를 작성해서 편안한 협업이 되었으면 좋겠습니다

하지만 어찌 됐든 commit 메시지 스타일은 팀원들과 잘 상의하여 서로에게 맞춰가며 하는 것이 제일 좋다고 생각합니다
그래도 제 글이 좋은 commit 메시지를 작성하는데 도움이 되었으면 좋겠습니다