Skip to content

πŸ“ˆ Git μ „λž΅

Yongsu Lim edited this page Nov 5, 2024 · 6 revisions

βœ’ Commit Convention

Commit λ‚΄μ—­ 만으둜 μ™„λ£Œν•œ κΈ°λŠ₯의 νžˆμŠ€ν† λ¦¬λ₯Ό νŒŒμ•…ν•˜κΈ° 쉽도둝 Commit Convention적용.

Header: 제λͺ© 이름
- λ””ν…ŒμΌν•œ 사항듀은
- μ΄λ ‡κ²Œ μΆ”κ°€ν•΄μš”

Header λͺ©λ‘

Header Content
UI ν™”λ©΄ 개발 (View, compose)
Feat κΈ°λŠ₯ 개발
Fix 버그 ν”½μŠ€
Refactor λ¦¬νŒ©ν† λ§ 진행
Docs λ¬Έμ„œ μˆ˜μ •, 주석 μΆ”κ°€
File 파일 μ‚­μ œ, 이름 λ³€κ²½
Chore 이외 ν”„λ‘œμ νŠΈ 변경사항(λΉŒλ“œ, 버전 λ³€κ²½)


βœ’ Branch Convention

배포λ₯Ό μ΅œμ’…μ μΈ λͺ©ν‘œλ‘œ μ„€μ •ν•΄ Git Flowλ₯Ό 기반으둜 브랜치 역할을 뢄리.


🌿 Branch Naming

Branch Name Description
main 배포가 κ°€λŠ₯ν•  μ •λ„λ‘œ 리뷰된 μ½”λ“œ & μ•žμœΌλ‘œμ˜ μΆ”κ°€ 개발의 baseκ°€ 될 수 μžˆλŠ” μ½”λ“œ
dev κ°œλ°œμ€‘μΈ branch, feature의 merge λŒ€μƒ
feature κΈ°λŠ₯ λ‹¨μœ„μ˜ branch
releases 배포 κΈ°λŠ₯ μ„€μ • ν›„ μ•ˆμ •ν™”μš© 브랜치

πŸ“€ Push μˆœμ„œ

  1. μž‘μ—…μ§„ν–‰
  2. git pull {remote} dev
  3. push β†’ pr - dev

β€» pull을 ν•  λ•Œμ—λŠ” rebaseλ₯Ό ν™œμš© ( git pull β€”rebase remote [branch] )

feature/branch-name


βœ’ Pull Request Convention

  1. mainλΈŒλžœμΉ˜λŠ” 직접 pushκ°€ λΆˆκ°€λŠ₯ ν•˜λ„λ‘ μ„€μ •.

  2. PRμš”μ²­μ‹œ λ°˜λ“œμ‹œ λͺ¨λ“  νŒ€μ›μ΄ approveν•΄μ•Ό 병합이 κ°€λŠ₯ν•˜λ„λ‘ μ„€μ •.

  3. PRμ‹œ λ°˜λ“œμ‹œ 리뷰 μ›ν•˜λŠ” 뢀뢄에 μ½”λ©˜νŠΈ μž‘μ„±.

  4. ν•˜λ‚˜μ˜ PR에 λ‹€λ₯Έ νŒ€μ› λͺ¨λ‘κ°€ 각각 적어도 1개 μ΄μƒμ˜ μ½”λ©˜νŠΈ μž‘μ„±.

  5. μ½”λ©˜νŠΈλŠ” λ°˜λ“œμ‹œ 1개 μ΄μƒμ˜ 칭찬을 ν¬ν•¨ν•˜κΈ°.

  6. PR λ³‘ν•©μ‹œ graph νžˆμŠ€ν† λ¦¬λ₯Ό μ„ ν˜•μœΌλ‘œ κ΄€λ¦¬ν•˜κΈ° μœ„ν•΄ μ˜΅μ…˜μ„ Rebase둜 μ§€μ •ν•˜κΈ°.

  7. 병합이 μ™„λ£Œλœ branchλŠ” Remote Repositoryμ—μ„œ μ‚­μ œν•˜κΈ°.

  8. PR 넀이밍은 λ‹€μŒκ³Ό 같이 μž‘μ„±.

    [{task_name}/#{issue_number}] 끝마친 μž‘μ—… λ‚˜μ—΄

    [Login/#2] 둜그인 api μ—°κ²° 


βœ’ Issue Convention

  1. μž‘μ—… μ§„ν–‰μ‹œ Issue 선택 ν›„ λ‚΄λΆ€μ˜ Create Branchλ₯Ό 톡해 μ—°λ™λœ Branch생성 ν›„ μž‘μ—… μ§„ν–‰ν•˜κΈ°.

    • μž‘μ—… μ™„λ£Œ ν›„ branchμ‚­μ œ μ‹œ Issueκ°€ μžλ™μœΌλ‘œ λ‹«νžˆλ„λ‘ ν•˜κΈ° μœ„ν•¨.
  2. commitμ‹œ μž‘μ—… λ‚΄μš©κ³Ό μ—°κ΄€λœ Issue번호λ₯Ό λ§ˆμ§€λ§‰μ— 적어주기 #{issue_number}

    • λ‹€λ₯Έ Issue의 μž‘μ—…μ„ 진행할 κ²½μš°μ—λŠ” ν•΄λ‹Ή Issue번호λ₯Ό ν•¨κ»˜ 적기
      ex) 버그 ν•΄κ²°κ³Ό 같은 μž‘μ—…

🏚 Home

✨ We are KOLOWN! ✨

πŸ“‹ Convention


πŸ–Ό Porring

πŸ“š 기획


🎨 λ””μžμΈ


⌨ 개발





πŸ“š Archive

♻️ νŒ€νšŒκ³ 

Clone this wiki locally