git Conventions

ProjectYOLO git Conventions

• Team YOLO의 Macro Project에서의 git Convention 입니다.
• git Convention을 최대한 잘 지켜서 건전한 Code Review 문화를 지향하고 Repository를 더욱 알차게 꾸며봅시다.

Commit convention

• Tags

  • [feat] : 새로운 기능을 추가
  • [design] : UI 디자인 변경
  • [refactor] : 코드 리팩토링
  • [fix] : 버그 수정
  • [remove] : 파일 삭제
  • [chore] : 파일 수정/이동, 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
  • [docs] : Documentation 변경

• Composition

  • Tags + #(Issue number) + Message
    • 각각의 구성 요소 사이는 띄어쓰기로 구분됩니다.
  • EX) [feat] #2 Add Login View

Branch convention

• dev branch는 직접 수정하지 않습니다.
• Merge된 branch는 바로 삭제합니다.
  • Merge 이후에 수정사항이 생긴다면 새로 issue를 만들고 branch를 생성합니다.
• 최대한 하나의 issue에 하나의 branch를 파서 해결합니다.
• Name Composition
  • Tag/Message/#Issue number
  • EX) feature/login/#2

PR convention

• 혼자서 임의로 Merge 하지 말고, 팀원들의 Code Review를 통해 의견을 교환해봅시다.
• Composition
  • 기본적인 구성은 Branch convention과 같습니다.
  • EX) feature/login/#2