Git Commit Message Convention - leegwichan/StackOverFlow_Refactoring GitHub Wiki

◎ 작성 규칙

  • Git Message는 현재 작업한 내용을 설명해주는 하나의 글이므로 해당 커밋에서 작업한 내용에 대한 이해가 가능하도록 작성함
  • Commit은 작업의 최소 단위로 진행하고, 작업한 모든 내용을 아래 형식에 맞춰 작성할 것

◎ Convention

<issue key> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

◎ Convention Details

  • issue key : Jira에서 사용하는 Issue의 key를 넣음
    • Jira에서 자동으로 commit과 issue가 연결되어 보기 용이하게 함
  • type : 해당 커밋의 타입을 적음
    • feat (기능 구현), fix (버그 수정), docs (문서화), style (형식 맞추기, 세미콜론 넣기, …), refactor (리팩토링), test (미처 추가하지 못한 테스트 및 테스트 케이스 추가), chore (유지 보수)
  • scope : 범위를 지정하는 모든 것이 될 수 있다[
    • 파일명, 도메인명, location, browser, complie ...]()
  • subject : 현재 작업을 간략히 한줄로 요약
  • body : 변경에 대한 동기에 대해 작성, 이전과 달라진 점 작성
  • footer : 주요 변경 사항, ...
⚠️ **GitHub.com Fallback** ⚠️