Skip to content

Instantly share code, notes, and snippets.

@PleahMaCaka
Last active May 15, 2023 12:13
Show Gist options
  • Save PleahMaCaka/a3e7779b7648ecc22726878d36e23c64 to your computer and use it in GitHub Desktop.
Save PleahMaCaka/a3e7779b7648ecc22726878d36e23c64 to your computer and use it in GitHub Desktop.
시맨틱 커밋 메세지

📝 시맨틱 커밋 메시지 (Semantic Commit Messages)

커밋 메시지 스타일을 약간 바꿈으로써 어떻게 더 나은 프로그래머가 될 수 있는지 알아보세요.

시맨틱 커밋 메세지는 수많은 스타일 중 하나입니다.
본인이 원하거나 꼭 따라야 하는것이 아니라면 억지로 사용하지 마세요.

포멧: <타입>(<스코프>): <짧은 요약>
Format: <type>(<scope>): <short summary>

<scope>선택적입니다.

✏️ 작성 방법

feat: 모자에 귀여워지는 효과 추가
^--^  ^------------^
|     |
|     +-> 짧고 간단한 요약 (현재 시제)
|
+-------> 타입: chore, docs, feat, fix, refactor, style, test 등

자세한 예시:

  • feat: (새로운 기능 추가)
  • perf: (성능을 위한 변경사항)
  • fix: (버그 해결 또는 이슈 해결에 대한 커밋)
  • ci: (CI 설정 또는 스크립트 변경)
  • cd: (CD 설정 또는 스크립트 변경)
  • ci/cd: (ci와 cd의 설정이 함께 변경되는 경우)
  • docs: (문서에 대한 변경사항)
  • style: (포멧팅, 세미콜론 추가/삭제 등; 실제로 작동하는 코드에 변경사항 없음)
  • refactor: (코드 리팩터링, 변수/함수의 이름 변경 등)
  • test: (테스트 코드 추가, 작동하는 코드는 그대로)
  • chore: (코드 수정 없이 설정을 변경 .gitignore, .editorconfig 등)
    • 이라곤 하지만 보통 '기타' 같은 느낌으로 사용하는걸 자주 목격할 수 있다.
    • '자잘한 변경사항' 같은 느낌으로 봐도 무리가 없다.

🚨 주의 끌기

주요 변경 사항을 강조하고 싶다면 아래와 같이 느낌표!와 함께 작성하세요!
feat!: 회원가입 인증 메일에 고양이 사진을 포함하지 않습니다.

만약 스코프를 포함한다면 다음과 같습니다.
feat(auth)!: 회원가입 인증 메일에 고양이 사진을 포함하지 않습니다.

fix(#99)!: 고양이 보안 문제 해결


번외: ⚡깃✨모🚀지🎉 사용하기

깃모지를 타입과 1:1로 대응시키세요.

다음과 같은 여러가지 방법으로 사용될 수 있습니다.

<emoji> <type>(<scope>): <short summary>
✨ feat(api)!: 제품 발송이 시작되면 유저에게 이메일 보내기
⚡ perf(api): 전반적인 API 설정 최적화
✨ feat(api): 제품 주문시 구매 기록에 추가하기

<emoji> <scope>: <short summary>
✨ 제품 발송이 시작되면 유저에게 이메일 보내기
⚡ API : 전반적인 API 설정 최적화
✨ API : 제품 주문시 구매 기록에 추가하기

<emoji> <short summary>

> 이 방법은 권장하지 않습니다. 왜? <

  1. 처음 기여하는 다른 사람이 익숙하지 않을 수 있습니다. <
  2. 환경에 따라 이모지가 다르게 보여 의미가 다르게 전달될 수 있습니다. <

✨ 제품 발송이 시작되면 유저에게 이메일 보내기
⚡ 전반적인 API 설정 최적화
✨ 제품 주문시 구매 기록에 추가하기

다양한 깃모지는 이곳에서 확인하세요.


🔥 참고자료:

@PleahMaCaka
Copy link
Author

Hits

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