Git commit 작성법

Commit 메시지 구조

type(타입) : title(제목)

body(본문, 생략 가능)

Resolves : #issue, ...(해결한 이슈 , 생략 가능)

See also : #issue, ...(참고 이슈, 생략 가능)

commit 규칙

• commit의 제목은 commit을 설명하는 하나의 구나 절로 완성
• Importance of Capitalize 대소문자의 중요성
• prefix 꼭 달기 - (type)
  • feat: 기능 개발 관련
  • fix: 오류 개선 혹은 버그 패치
  • docs: 문서화 작업
  • test: test 관련
  • conf: 환경설정 관련
  • build: 빌드 관련
  • ci: Continuous Integration 관련

ref. https://www.conventionalcommits.org/ko/v1.0.0/

commit 할 때 기억해야 할 것

• commit은 동작 가능한 최소단위로 자주 할 것.
• 해당 작업단위에 수행된 모든 파일 변화가 해당 commit에 포함되어야 함.
• 제목은 축약하여 쓰되(50자 이내), 내용은 문장형으로 작성하여 추가설명 할 것.
• 제목과 내용은 한 줄 띄워 분리할 것.
• 내용은 이 commit의 구성과 의도를 충실히 작성할 것.

 

CLI로 commit 메시지 작성 예시

$ git commit

$ git commit -m "메시지"  이 방법은 추천하지 않음

주로 마크다운 언어를 이용해서 작성한다.

docs: git commit write

- commit rule
- commit memory
- commit example
- Frequently used words

 

 

자주 쓰는 단어

• Fix
  • 잘못된 동작을고칠 때 주로 사용한다.
• Add
  • 무언가 추가할 때 사용한다.
• Remove
  • 삭제가 있을 때 사용한다.
• Simplify
  • 코드를 단순화 했을 때 사용한다.
• Updat
  • Fix와 달리 원래 정상적으로 동작했지만 보완하는 개념이다.
• Implment
  • 무언가 구현을 달성했을 때 사용한다. 큰 단위에 작성하면 좋다.
• Prevent
  • 특정한 동작을 못하게 막을 때 사용한다.
• Move
  • 코드나 파일의 이동에 사용한다.
• Rename
  • 이름의 변경이 있을 때, Rename A to B의 형태로 많이 쓰인다.

 

내 생각 정리하기

commit은 협업을 위한 필수! 이부분은 어떤 변화가 있었는지 빠르게 알 수 있는 부분으로 문제가 생겼을 때 확인하기 용의하다.모든 혼자하는 것이 아닌 동료들과 협업을 통해 이루어짐으로 누구나 알아보기 쉽고 간략하게 정리하여 커밋.작은 동작 단위로 커밋! 많은 부분을 한 번에 커밋하는 것은 좋지않다.

다음은 commit과 README.md를 위한 마크다운 사용법을 정리해보자.