Convention - mistyblue0302/food_ordering_service GitHub Wiki

Coding Convention

Commit Message Convention

  • 기본적으둜 ν•œκΈ€λ‘œ μž‘μ„±ν•œλ‹€.
[#issueNumber] <type>: <title>

type

  • feat: 기쑴에 μ—†λ˜ κΈ°λŠ₯ μΆ”κ°€
  • fix: 이슈 μˆ˜μ •
  • docs: μ½”λ“œμ™€λŠ” 상관이 μ—†λŠ” λ¬Έμ„œκ°€ μΆ”κ°€ 및 μˆ˜μ • 될 경우
  • style: μ½”λ“œ ν¬λ§·νŒ…, μ„Έλ―Έμ½œλ‘  λˆ„λ½, μ½”λ“œ 변경이 μ—†λŠ” 경우
  • design: λ””μžμΈμ΄ λ³€κ²½λ˜μ–΄ ν•΄λ‹Ή 뢀뢄을 μˆ˜μ •ν•˜λŠ” μ½”λ“œλ₯Ό μ§€ 경우
  • refactor: μ½”λ“œ λ¦¬νŒ©ν† λ§ν•  경우
  • test: ν…ŒμŠ€νŠΈ μ½”λ“œ κ΄€λ ¨ μž‘μ—…μ„ ν•  경우
  • chore: ν”„λ‘œμ νŠΈ μ„€μ • κ΄€λ ¨ μž‘μ—…μ„ ν•  경우

title

:(콜둠) λ’€ 곡백 ν•˜λ‚˜λ₯Ό 두고 μž‘μ„±ν•œλ‹€.

Git Branch μ „λž΅

Github flow

main 브랜치λ₯Ό μ€‘μ‹¬μœΌλ‘œ μš΄μ˜ν•˜κ³ , μž‘μ—…μš© λΈŒλžœμΉ˜λŠ” κ΅¬λΆ„ν•˜μ§€ μ•ŠλŠ” λ‹¨μˆœν•œ ꡬ쑰둜 규λͺ¨κ°€ μž‘κ³ , 배포가 μˆ˜μ‹œλ‘œ μΌμ–΄λ‚˜λŠ” ν”„λ‘œμ νŠΈμ— μœ λ¦¬ν•˜λ‹€.

μž‘μ—… 흐름

  • 브랜치 생성
    • 개발, 버그, ν”½μŠ€ λ“± μ–΄λ–€ μ΄μœ λ‘œλ“  μž‘μ—…ν•  λ•Œ μƒˆλ‘œμš΄ 브랜치λ₯Ό μƒμ„±ν•œλ‹€.
    • main λΈŒλžœμΉ˜λŠ” 항상 μ΅œμ‹  μƒνƒœλ₯Ό μœ μ§€ν•œλ‹€.
    • μƒˆλ‘œμš΄ λΈŒλžœμΉ˜λŠ” 항상 main λΈŒλžœμΉ˜λ‘œλΆ€ν„° λ§Œλ“ λ‹€.
    • μžμ‹ μ΄ μ–΄λ–€ μž‘μ—…μ„ ν•˜κ³  μžˆλŠ”μ§€λ₯Ό 브랜치 μ΄λ¦„μœΌλ‘œ λͺ…ν™•ν•˜κ²Œ ν‘œν˜„ν•œλ‹€.
  • 개발, 컀밋, 푸쉬
    • 컀밋 λ©”μ‹œμ§€λ₯Ό λͺ…ν™•ν•˜κ²Œ μž‘μ„±ν•œλ‹€.
    • 원격 브랜치λ₯Ό μˆ˜μ‹œλ‘œ push ν•œλ‹€.
  • Pull Request 생성
    • merge μ€€λΉ„κ°€ μ™„λ£Œλλ‹€λ©΄ main 브랜치둜 λ°˜μ˜μ„ μš”κ΅¬ν•œλ‹€.
  • ν…ŒμŠ€νŠΈ
    • μ½”λ“œ 리뷰가 끝났닀면 ν•΄λ‹Ή λ‚΄μš©μ„ 개발 μ„œλ²„μ— λ°°ν¬ν•œλ‹€.
    • λ°°ν¬μ‹œ λ¬Έμ œκ°€ λ°œμƒν•˜λ©΄ κ³§μž₯ main 브랜치의 λ‚΄μš©μ„ λ‹€μ‹œ λ°°ν¬ν•˜μ—¬ μ΄ˆκΈ°ν™”ν•œλ‹€.
  • μ΅œμ’… Merge
    • 개발 μ„œλ²„μ— 배포해도 λ¬Έμ œκ°€ λ°œκ²¬λ˜μ§€ μ•Šμ•˜λ‹€λ©΄ κ·ΈλŒ€λ‘œ main λΈŒλžœμΉ˜μ— ν‘Έμ‹œν•˜κ³  μ¦‰μ‹œ 배포λ₯Ό μ§„ν–‰ν•œλ‹€.
    • main으둜 mergeκ°€ μΌμ–΄λ‚˜λ©΄ μžλ™μœΌλ‘œ 배포가 λ˜λ„λ‘ μ„€μ •ν•œλ‹€.

μ°Έκ³  λ‚΄μš© : Github-Flow μ „λž΅μ— λŒ€ν•΄μ„œ

⚠️ **GitHub.com Fallback** ⚠️