Convention - f-lab-edu/home-delivery GitHub Wiki

Convention

ν˜‘μ—…μœΌλ‘œ μ§„ν–‰λ˜λŠ” ν”„λ‘œμ νŠΈμ΄κΈ° λ•Œλ¬Έμ— μ†Œν†΅μ„ μœ„ν•΄ Convetion 을 μ •μ˜ν•˜μ—¬ μ΅œλŒ€ν•œ ν†΅μΌλ˜κ²Œ μ½”λ“œλ₯Ό μž‘μ„±ν•˜κ³  진행될 수 μžˆλ„λ‘ ν–ˆμŠ΅λ‹ˆλ‹€

컀밋 λ©”μ‹œμ§€

컀밋ꡬ뢄 μ„€λͺ…
Feat (feature)κ°œμ„  λ˜λŠ” κΈ°λŠ₯ μΆ”κ°€
Bug (Bug Fix)버그 μˆ˜μ •
Doc (Documentation)λ¬Έμ„œ μž‘μ—…
Test (Test)ν…ŒμŠ€νŠΈ μΆ”κ°€/μˆ˜μ •
Bld (Build)λΉŒλ“œ ν”„λ‘œμ„ΈμŠ€ κ΄€λ ¨ μˆ˜μ •(yml)
Perf (Performance)속도 κ°œμ„ 
Refactor (Refactoring) μ½”λ“œ 정리 / λ¦¬νŒ©ν† λ§

Code Convention

  • Google code Style을 μ€€μˆ˜
  • STS Check Style ν”ŒλŸ¬κ·ΈμΈμ„ μ μš©ν•˜μ—¬ μ½”λ“œ μ»¨λ²€μ…˜μ„ μœ μ§€
  • Commit μ „ Check Style둜 확인 ν›„ Commit

브랜치 μ „λž΅

  • Git-flow λ₯Ό μ‚¬μš©ν•˜μ—¬ 브랜치λ₯Ό 관리
  • κΈ°λŠ₯ κ΅¬ν˜„μ‹œ develop μ—μ„œ flow λ₯Ό μ‹œμž‘ν•˜μ—¬ feature 브랜치λ₯Ό λ§Œλ“€κ³  κΈ°λŠ₯ κ΅¬ν˜„μ΄ λλ‚˜λ©΄ PR 및 리뷰 ν›„ merge

image

  • master : μ œν’ˆμœΌλ‘œ μΆœμ‹œλ  수 μžˆλŠ” 브랜치
  • develop : λ‹€μŒ μΆœμ‹œ 버전을 κ°œλ°œν•˜λŠ” 브랜치
  • feature : κΈ°λŠ₯을 κ°œλ°œν•˜λŠ” 브랜치
  • release : 이번 μΆœμ‹œ 버전을 μ€€λΉ„ν•˜λŠ” 브랜치
  • hotfix : μΆœμ‹œ λ²„μ „μ—μ„œ λ°œμƒν•œ 버그λ₯Ό μˆ˜μ • ν•˜λŠ” 브랜치

μ°Έκ³  : μš°μ•„ν•œν˜•μ œλ“€ κΈ°μˆ λΈ”λ‘œκ·Έ

PR

  • PR μƒμ„±μ‹œ [#이슈번호] 제λͺ© 에 λ§žμΆ°μ„œ 생성
  • λ‚΄μš©μ€ μž‘μ—… λ‚΄μš© κ³Ό λ‹€μŒ μ˜ˆμ • μž‘μ—…μ— 맞좰 μž‘μ„±
  • PRμ‹œ λ°˜λ“œμ‹œ 1λͺ… μ΄μƒμ˜ λ¦¬λ·°μ–΄μ—κ²Œ 리뷰λ₯Ό λ°›κ³  ν”Όλ“œλ°±μ„ λ°˜μ˜ν•˜μ—¬ λ¦¬νŒ©ν† λ§ ν›„ merge
  • merge 방식은 merge ν›„ κΉ”λ”ν•œ 컀밋 내역을 μœ„ν•΄ squash and merge 을 μ‚¬μš©
⚠️ **GitHub.com Fallback** ⚠️