커밋, Branch 컨벤션

커밋 컨벤션

• 내용은 한글로 작성하기

  • feat: 새로운 기능
  • fix: 컴파일 오류나 논리적 오류
  • docs: 문서 업데이트
  • style: 포맷팅, 변수, 함수명 변경, 패키지 명 변경
  • refactor: 로직적인 코드의 변경
  • test: 로직적인 코드에 영향을 주지 않는 테스트 함수 작성
  • chore: Build 의존성 추가 등

  참고한 자료
  https://udacity.github.io/git-styleguide/

• commit message 마지막에 Issue 고유 번호 포함하기

Branch 컨벤션

• Branch는 Issue에서 직접 생성합니다.
  https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue

• branch 이름은 아래 형식을 가집니다.
  issue number-branch purpose-short description-작성자를 구분하기 위한 이름
  ex) 12-feature-move-marker-on-map-js

  • feature branch -> 기능을 개발하는 branch. develop branch에서 fork해서 작업합니다.
  • develop branch -> 그 주의 스프린트 작업 내용을 merge하는 branch.
  • develop-검색화면-장소검색화면-김시진 -> 그 주의 각자의 스프린트 작업 내용을 merge하는 branch. 이 branch에 merge할 때는 코드 리뷰 요청 X
  • master -> develop branch를 master branch에 merge 하기 전에, 각자 분업했던 내용이 문제 없이 연결되어 있는지 처리 후 merge합니다.

• 매 주 금요일에 있는 데모 시연 영상은 master branch로 녹화합니다.
  https://iamcho2.github.io/2021/03/22/branch-rule-git-flow https://deepsource.io/blog/git-branch-naming-conventions/

• 코드 리뷰 요청 기준
  develop-검색화면-장소검색화면-김시진을 develop branch에 merge할 때만 PR에 대해 코드 리뷰 요청하기