[Git] 2. Commit Convention

 

다른 사람들과의 협업을 위해서는 커밋을 할 때 커밋 메시지를 간략하지만, 확실하게 내용을 담아줘야 빠르게 이해를 할 수 있다. 

만약 커밋 메세지를 남기지 않는다면, 팀원들의 사랑스러운 눈빛을 잔뜩 받을 수 있을 것이다.

(커밋 메세지를 안 남기면, 니가 뭘 했는지 내가 어떻게 알아 이자식야^^)

 

커밋을 나만의 규칙으로 내 맘대로 하면 참 좋겠지만, 그러면 다른 사람은 못알아듣는 대참사가 발생할 수 있다.

물론 팀내의 커밋 규칙이 있다면, 그 규칙을 우선적으로 따르는 게 좋다.

일반적으로 사용하는 커밋규칙은 다음과 같다.

 

General Conventional Commit

1. commit의 제목은 commit을 설명하는 하나의 구나 절로 완성
2. importanceofcapitalize
   1. 대소문자로 확실한 구분을 해줘야 한다.
3. prefix 꼭 달기!
   1. feat : 기능 개발 관련 (파일추가, 기능추가 등)
   2. fix : 오류 개선 혹은 버그 패치
   3. docs : 문서화 작업
   4. test : test 관련
   5. conf : 환경설정 관련(.env, .gitignore, dockerfile, requirements 추가 등)
   6. build : 빌드 관련
   7. ci : Continuous Integration 관련
   8. BREAKING CHANGE : 긴급 수정(서비스 돌아가는 중에 많이 사용됨)
   9. refactor : 리팩토링 관련

---

이 외에도 커밋을 할 때 일반적으로 지키면 좋은 규칙들도 있다.

반드시 지킬 필요는 없으나, 효율적인 관리 및 협업을 위해서는 다음 규칙까지 따르면 좋을 것이다.

Commit Rule

1. commit은 동작 가능한 최소단위로 자주 하기!
2. 해당 작업단위에 수행된 모든 파일 변화가 해당 commit에 포함시키기
3. 모두가 이해할 수 있는 log를 작성하기
4. Open Source Contribution시 영어가 강제되지만, 그렇기 않을 경우 팀 내 사용 언어를 따라 쓰기
5. 제목은 축약해서 쓰되, 내용은 문장형으로 작성하여 추가 설명하기
6. 제목과 내용은 한 줄 띄워 분리하기
7. 내용은 이 commit의 구성과 의도를 충실히 작성하기

그럼 필자는 이제 깃헙을 사용해서 협업하는 연습을 하러 이만 가보도록 하겠다.ㅎㅎ

Adios!