<aside> 💡 최종 프로젝트를 위해 연습하는 것이니까 여러가지 시도해보고, 실수해도 OK 그치만 -f 는 안됨.

</aside>

Git Flow 진행

• 가장 최신 Commit의 위치가 Local

Branch

• main
  • 배포의 기준이 되는 브랜치
  • 직접 commit X
  • develop, release, hotfix 브랜치 merge
• develop
  • 개발이 이루어지는 브랜치
  • conflict 발생을 막기위해 feature 브랜치에서 작업 → develop 브랜치에 merge
• feature

  • 실제로 기능 구현하는 브랜치

  • 작업이 완료된 경우 code review를 통해 develop 브랜치에 merge

  • feature branch 작명시 issue기반으로 작성

    • tag_issuetag/branch-name
    • ex>

    feat_3/cross_validation
    

Commit

git commit -s -m "commit message"

• -s : 커밋 서명
• Commit Convention - 첫글자 대문자로 작성

  • Header (필수, 영어)

    • [Tag] : 동사원형 목적어(명령문)
    • Tag
      • Feat (새로운 기능)
      • Refactor (리팩토링)
      • Fix (버그 수정)
      • Style (코드 포맷팅, 주석처리)
      • Chore (빌드 수정, 패키지 관리자 수정)
      • Tests (테스트 코드)
      • Docs (문서 작업)

  • Body (선택, 한글)

    • • Body
    • Header와 한줄 공백

  • Footer (필수)

    • 해당 작업과 관련된 issue 의 tag (#{Issue 번호}) 를 달아서 양방향 참조할 수 있음
    • 작업 History 관리 목적으로 사용
    • Header 또는 Body와 한줄 공백
    • 종료 키워드와 issue 번호를 함께 쓰면 이슈 종료됨
      • close
      • closes
      • closed
      • fix
      • fixes
      • fixed
      • resolve
      • resolves
      • resolved

  • ex> [Tag] Commit Message

    [Refactor] Modify api handler logic
    
    - change logic 1
    - change logic 2
    
    #3
    

  • Pre-commit - 개인 필수 진행

    • Hooks : black
    • Pre-commit 설치 방법
    • GitHub Actions - 제가 하겠습니다.

Issue

개발 작업 단위로 작성

• 작업이 필요한 사항이 있다면, issue로 등록

• 각 issue에 맞는 Feature 브랜치를 생성해 작업 진행 → 브랜치명에 lssue Tag 붙여서 식별하기 쉽게 함

• Assignee : 작업자 등록

• Issue Template

  • .github/ISSUE_TEMPLATE/issue_template.md
  • Tag : Commit message Tag와 동일

  ---
  name: issue_template
  about: '프로젝트에 필요한 사항을 제안할 때 사용한다. '
  title: "[]"
  labels: ''
  assignees: ''
  
  ---
  
  ## Background : 작업 수행 배경
  -
  -
  
  ## To Do : 수행할 작업
  - [ ]
  - [ ]
  
  ## See Also : 관련 이슈/작업
  -
  

• Create a merge commit : Merge 커밋을 추가로 남기고 Merge

• Squash and merge : 커밋 로그들을 하나로 합치면서 Merge

• Rebase and merge : Merge 커밋을 남기지 않으면서 기존 커밋 로그를 유지하는 상태로 Merge

Pull Request

다른 브랜치로 merge 하기 전, 팀원에게 코드 리뷰를 받는 단계