본문 바로가기
프론트엔드/Git & GitHub

Git & GitHub | 커밋 메세지 규칙 - Git Commit Message Conventions

by YUNI Heo 2024. 5. 14.
반응형

 

⭕ Git & GitHub | 커밋 메세지 규칙 - Git Commit Message Conventions

 

Git Commit Message Conventions

Git Commit Message Conventions. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

 

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

 

➡️ Subject line

  • Allowed <type>
    • feat (feature)
    • fix (bug fix)
    • docs (documentation)
    • style (formatting, missing semi colons, …)
    • refactor
    • test (when adding missing tests)
    • chore (maintain)
  • Allowed <scope>
    • Scope could be anything specifying place of the commit change
    • For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...
  • <subject> text
    • use imperative, present tense: “change” not “changed” nor “changes”
    • don't capitalize first letter
    • no dot (.) at the end

 

➡️ Message body

  • just as in use imperative, present tense: “change” not “changed” nor “changes”
  • includes motivation for the change and contrasts with previous behavior

 

➡️ Message footer

  • Breaking changes : All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes
  • Referencing issues : Closed bugs should be listed on a separate line in the footer prefixed with "Closes" keyword

 

반응형