Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save jinan159/fc38777ab129f389be5e984e81f1d904 to your computer and use it in GitHub Desktop.
Save jinan159/fc38777ab129f389be5e984e81f1d904 to your computer and use it in GitHub Desktop.
Semantic Commit Messages

Semantic Commit Messages

아래 방법처럼 커밋 메세지 형식을 조금만 변경하면 당신도 더 나은 개발자가 될 수 있습니다.

형식: <종류>(<범위>): <제목>

<범위> 는 옵션입니다.

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> 현재 시제로 요약하여 작성
|
+-------> 종류: feat, fix, build, docs, style, refactor, test, chore

More Examples:

  • feat: 사용자를 위한 새로운 기능 (빌드 스크립트를 위한 새로운 기능은 해당하지 않음)
  • fix: 사용자 기능의 버그•오류를 수정, (빌드 스크립트를 위한 변경사항은 해당하지 않음)
  • docs: 문서 작성 및 변경
  • style: 줄 맞춤, 빠트린 세미콜론 추가 (운영 코드 변경이 포함되면 안됨)
  • refactor: 운영 코드 리펙토링(변수명 변경 등)
  • test: 빠트린 테스트 추가, 테스트 코드 리펙토링 등 (운영 코드 변경이 포함되면 안됨)
  • build: 빌드 스크립트를 위한 변경

  • chore: Grunt task 수정(운영 코드 변경이 포함되면 안됨)
    • 여기서 Grunt의 의미는 여기에 나와있는 내용으로 추측됩니다. Node 환경에서 작업을 자동화 하는데 사용되는 도구인 것 같은데, chore 라는 단어보다 build 라는 단어가 더 익숙해서 저는 개인적으로 build 라고 대체하여 사용하려 합니다.

명확한 설명을 위해 의역한 부분이 있습니다.
혹시 잘못 번역하였거나, 잘못된 내용있으면 알려주시면 감사하겠습니다🙏

References:

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • build: (changes for build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

References:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment