commit messages

Patterns for writing better git commit messages

더 나은 git 커밋 메시지를 작성하기 위한 패턴

Types

• asdasdasd
• feat : A new feature
  • 새로운 기능 개발
• fix : A bug fix
  • 버그 수정
• refactor : refactoring production code
  • 코드 리팩토링
• chore : Build process, no production code change
  • 패키지 or 빌드 프로세스 또는 보조 도구 변경
  • pakage.json, .gitignore
• docs : Documentation only changes
  • 문서 만 변경
  • README.md
• perf : A code change that improves performance
  • 성능을 향상 시키는 코드 변경
• revert : Reverting things
  • 코드 되돌리기
• style : formatting, missing semicolons, markup, white-space
  • 마크업, 줄바꿈, 공백, 서식, 세미콜론 누락 등 포맷팅
• build : Build related changes
  • 빌드 관련 변경 사항
• test : Adding missing tests
  • 테스트 관련 코드
• ci : CI related changes
  • CI 관련 변경사항
  • CI : CI (Continuous Integration)
    여러 개발자가 작성하거나 수정한 소스를 지속적으로 통합하고 테스트하는 것
  • CD (Continuous Delivery/Deployment)
    개발, 통합, 배포, 릴리즈, 테스트를 자동화하여 지속적으로 배포하는 것

Example

git commit -m 'feat: implement VOD content reels'
git commit -m 'fix: routing issue on the main page'
git commit -m 'docs: correct spelling of README'
git commit -m 'chore: update eslint to v4.2.0'

The 7 rules of a great commit message

The seven rules of a great Git commit message
Keep in mind: This has all been said before.

• Separate subject from the body with a blank line
  • 제목과 본문을 빈 줄로 구분하기
• Limit the subject line to 50 characters
  • 제목 줄을 50 자로 제한할 것
• Capitalize the subject line
  • 제목을 대문자로 작성
• Do not end the subject line with a period
  • 마침표로 제목을 끝내지 말것
• Use the imperative mood in the subject line
  • 제목에 명령형으로 작성
• Wrap the body at 72 characters
  • 본문을 72 자 내로 작성
• Use the body to explain what and why vs. how
  • 본문은 무엇을, 왜, 어떻게 형태로 작성