Git Convention - codestates-seb/seb41_main_004 GitHub Wiki

Git Convention

1. Issue

  • 이슈 μƒμ„±μ‹œ μ μ ˆν•œ 라벨과 ν”„λ‘œμ νŠΈλ₯Ό μ§€μ • ν›„ κ²Œμ‹œν•©λ‹ˆλ‹€.
  • template
    • title

      [scope] title
      β€» scope: ν•΄λ‹Ή μ΄μŠˆμ™€ κ΄€λ ¨λœ 도메인
      β€» title: μž‘μ—…μ— λŒ€ν•œ μš”μ•½
      
      [auth/login] 둜그인 κΈ°λŠ₯ κ΅¬ν˜„
      
    • body

      
      ### ν•˜κ³ μž ν•˜λŠ” μž‘μ—…μ΄ λ¬΄μ—‡μΈκ°€μš”?
      둜그인 κ΄€λ ¨ν•œ μ‚¬μš©μž 인증 κΈ°λŠ₯을 κ΅¬ν˜„ν•©λ‹ˆλ‹€.
      
      ### ν•΄λ‹Ή κΈ°λŠ₯을 κ΅¬ν˜„ν•˜κΈ° μœ„ν•΄ ν•  일이 λ¬΄μ—‡μΈκ°€μš”?
      - [ ] web security μ„€μ ˆ
      - [ ] μœ μ €λ„€μž„, λΉ„λ°€λ²ˆν˜Έ 검증 κΈ°λŠ₯ κ΅¬ν˜„
      - [ ] κ²€μ¦μ˜ 성곡/μ‹€νŒ¨μ— λ”°λ₯Έ 둜직 κ΅¬ν˜„
      
      ### μ˜ˆμƒ μž‘μ—… μ‹œκ°„
      1d
      

2. Branch 생성 κ·œμΉ™

  • κΈ°λ³Έ ν˜•μ‹ : [type]/[scope]
git branch auth/login
# λ˜λŠ”
git switch -c auth/login
  • κΈ°λŠ₯ κ΅¬ν˜„μ΄ μ™„λ£Œλ˜λ©΄ Branch PR ν•©λ‹ˆλ‹€.
  • Pull Request ν›„ Merge된 λΈŒλžœμΉ˜λŠ” μ‚­μ œν•©λ‹ˆλ‹€.

3. Pull request

  • 기본적으둜 PR은 이슈λ₯Ό κΈ°μ€€μœΌλ‘œ μž‘μ„±ν•©λ‹ˆλ‹€.
  • Hotfix λ“± κΈ‰ν•œ 사항이 μ•„λ‹ˆλ©΄ Issue 생성 ν›„ PR을 ꢌμž₯ν•©λ‹ˆλ‹€.
  • template
    • body

      ## κ°œμš”
      둜그인 과정을 λ°±μ—”λ“œ λΆ€λΆ„ κ΅¬ν˜„ν•˜μ˜€μŠ΅λ‹ˆλ‹€.
      
      ## μ£Όμš” μž‘μ—…μ‚¬ν•­
      - web security μ„€μ ˆ
      - jwt μƒμ„±ν•˜λŠ” tokenizer 클래슀 κ΅¬ν˜„
      - UserDetailService κ΅¬ν˜„
      - μ‚¬μš©μž 정보가 μž…λ ₯됐을 λ•Œ credential ν™•μΈν•˜λŠ” κ³Όμ • κ΅¬ν˜„(Authentication)
      - μƒμ„±λœ jwtλ₯Ό μ΄μš©ν•˜μ—¬ 둜그인힌 μ‚¬μš©μ§€μ—κ²Œ μš”μ²­μ΄ 듀어왔을 λ•Œ ν•„μš”ν•œ jwt μœ νš¨μ„± 검증 κ³Όμ • κ΅¬ν˜„
      
      ## κΈ°λŠ₯ μ™Έ 변경사항(개발 λ²”μœ„ μ™Έ μˆ˜μ •λœ 사항 λ“±)
      - UserDetailService κ΅¬ν˜„ κ³Όμ •μ—μ„œ μž…λ ₯ν•˜λŠ” νšŒμ›(Member) μ •λ³΄μ˜ 값이 λ‹¬λΌμ‘ŒμŠ΅λ‹ˆλ‹€.
      
      ## 기타
      - web security 섀정에 따라 apiλ³„λ‘œ 토큰 인증을 ν•„μš”λ‘œ ν•  수 μžˆμŠ΅λ‹ˆλ‹€. 각 도메인 λ‹΄λ‹Ήμž 확인 ν•„μš”.
      - web security 섀정에 따라 cors μ΄μŠˆκ°€ λ°œμƒν•  수 μžˆμŠ΅λ‹ˆλ‹€. 문제 생기면 이슈 제보 λΆ€νƒλ“œλ¦½λ‹ˆλ‹€.
      - ν˜„μž¬ access token λ§Œλ£Œμ‹œ refresh tokenλ₯΄μ˜€ μƒˆλ‘œμš΄ 토큰 μƒμ„±ν•˜λŠ” λ‘œμ§μ€ μ—†μŠ΅λ‹ˆλ‹€. 27일 κ΅¬ν˜„ μ˜ˆμ •.
      

4. Commit

  • ν•˜λ‚˜μ˜ 컀밋은 λ˜λ„λ‘ ν‹°μΌ“(Issue)의 μž‘μ—…μœΌλ‘œ ν•©λ‹ˆλ‹€.

  • templateese

    • template

      [#issue-no] tag: summary
      β€» tag: tag에 λŒ€ν•œ μ„€λͺ…은 ν•˜λ‹¨ ν…Œμ΄λΈ”μ„ μ°Έμ‘°ν•˜μ„Έμš”.
      β€» summary: μ–΄λ–€ λ‚΄μš©μ„ μˆ˜μ •ν•˜λŠ”μ§€ κ°„λž΅ν•˜μ§€λ§Œ ν™•μ‹€νžˆ μ•Œ 수 μžˆλ„λ‘ ν•œκΈ€λ‘œ κΈ°μž…ν•©λ‹ˆλ‹€.
      β€» issue-no: ν•΄λ‹Ή 컀밋과 κ΄€λ ¨λœ 이슈의 번호λ₯Ό μ²¨λΆ€ν•©λ‹ˆλ‹€.
      
      [#23] feat: ꡬ글 OAuth2λ₯Ό ν†΅ν•œ λΉ„νšŒμ› νšŒμ›κ°€μž… κΈ°λŠ₯ κ΅¬ν˜„
      [#24] design: μ§ˆλ¬Έκ²Œμ‹œνŒ κ²Œμ‹œκΈ€ 제λͺ© 및 λ³Έλ¬Έ 간격 μ‘°μ •
      
  • commit type

    tag description
    feat μƒˆλ‘œμš΄ κΈ°λŠ₯을 μΆ”κ°€ν•œ 경우
    fix 버그λ₯Ό 고친 경우
    docs λ¬Έμ„œ λ˜λŠ” 주석 κ΄€λ ¨ (md 파일 λ“±)
    style μ½”λ“œ 포맷 λ³€κ²½, μ„Έλ―Έ 콜둠 λˆ„λ½, μ½”λ“œ μˆ˜μ •μ΄ μ—†λŠ” 경우
    refact ν”„λ‘œλ•μ…˜ μ½”λ“œ λ¦¬νŒ©ν„°λ§
    test ν…ŒμŠ€νŠΈ μΆ”κ°€, ν…ŒμŠ€νŠΈ λ¦¬νŒ©ν„°λ§ (ν”„λ‘œλ•μ…˜ μ½”λ“œ λ³€κ²½ μ—†μŒ)
    chore λΉŒλ“œ νƒœμŠ€ν¬ μ—…λ°μ΄νŠΈ, νŒ¨ν‚€μ§€ λ§€λ‹ˆμ € μ„€μ •ν•  경우 (ν”„λ‘œλ•μ…˜ μ½”λ“œ λ³€κ²½ μ—†μŒ)
    deploy 톡합 및 배포와 κ΄€λ ¨λœ μž‘μ—…
⚠️ **GitHub.com Fallback** ⚠️