Commit_PR_convention - miniRT-jiphyeonjeon/MiniRT GitHub Wiki

Commit && Pull Request κ·œμΉ™

commit messageλŠ” conventional commit extension μ‚¬μš©

1. Issue 등둝

2. Branch 생성

  • (option) tracking branch μ΄μš©ν•˜κΈ°
  • branch 이름은 intra_id/issueN/issue_title

3. Commit message

[type & gitmoji] Title

Body

Footer

type & gitmoji

  • feat:✨ μƒˆλ‘œμš΄ μ½”λ“œ μΆ”κ°€
  • fix:πŸ› 버그 μˆ˜μ •
  • docs:πŸ“ λ¬Έμ„œ μˆ˜μ •
  • style:🚨 norm μˆ˜μ •
  • refactor:♻️ μ½”λ“œ λ¦¬νŒ©ν† λ§
  • test:πŸ§ͺ ν…ŒμŠ€νŠΈ μ½”λ“œ
  • build:πŸ—οΈ λΉŒλ“œ μ‹œμŠ€ν…œ (=make)
  • ci:πŸ‘· github action
  • chore:✏️ μžμž˜ν•œ μˆ˜μ •
  • revert:βͺ️ 컀밋 되돌리기

title

  • 제λͺ©μ€ μ˜μ–΄λ‘œ μž‘μ„±
  • 동사 μ›ν˜•μœΌλ‘œ μ‹œμž‘
  • 첫 κΈ€μžλŠ” λŒ€λ¬Έμžλ‘œ μž‘μ„±
    • Add, Fix, Remove ...

body

  • 핡심 μš”μ•½

footer

  • μ—°κ΄€λœ github issue 번호 κΈ°μž…ν•˜κΈ°

4. Rebase

  • tracking branch - git pull
  • 일반 branchμ—μ„œλ„ git rebase -i main branch μ΄μš©ν•΄μ„œ 미리 rebase ν•˜κΈ°

5. PR

  • μƒλŒ€λ°©μ΄ 이해할 수 μžˆλ„λ‘ μΆ©λΆ„νžˆ μžμ„Έν•˜κ²Œ μž‘μ„±ν•˜κΈ°
  • 이해할 수 μžˆλ‹€λŠ” 것은 이 컀밋이 μ™œ ν•„μš”ν–ˆλŠ”μ§€, μ–΄λ–€μ‹μœΌλ‘œ μˆ˜μ •λ˜μ—ˆλŠ”μ§€, μ–΄λ–€ κ²°κ³Όκ°€ λ‚˜μ™”λŠ”μ§€λ₯Ό λ‹΄κ³  μžˆμŒμ„ 의미
⚠️ **GitHub.com Fallback** ⚠️