Skip to content

Instantly share code, notes, and snippets.

@PleahMaCaka

PleahMaCaka/Current convention for me.md

Last active November 24, 2023 02:45
Show Gist options
  • Save PleahMaCaka/265247d65f3eee48b394c33936ede0ea to your computer and use it in GitHub Desktop.
Save PleahMaCaka/265247d65f3eee48b394c33936ede0ea to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Current convention for me.md

πŸ“ μ‹œλ§¨ν‹± 컀밋 λ©”μ‹œμ§€ (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: (λ¬Έμ„œμ— λŒ€ν•œ 변경사항)
    • docs(README): added about development guide
  • style: (ν¬λ©§νŒ…, μ„Έλ―Έμ½œλ‘  μΆ”κ°€/μ‚­μ œ λ“±; μ‹€μ œλ‘œ μž‘λ™ν•˜λŠ” μ½”λ“œμ— 영ν–₯ μ—†μŒ)
  • refactor: (μ½”λ“œ λ¦¬νŒ©ν„°λ§, λ³€μˆ˜/ν•¨μˆ˜μ˜ 이름 λ³€κ²½ λ“±)
  • test: (ν…ŒμŠ€νŠΈ μ½”λ“œ μΆ”κ°€)
  • chore: (μžμž˜ν•œ μˆ˜μ •, .gitignore || .editorconfig λ“±)

🚨 Attention!

μ£Όμš” 변경사항, 단일 λŒ€ν˜• 컀밋
feat!: νšŒμ›κ°€μž… 인증 메일에 고양이 사진을 ν¬ν•¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.

πŸ”₯ 참고자료:

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