Git convention

Git-Flow

• feature
• develop
• release
• production (=main =master)
• hotfix

Process

1. 새 브랜치 생성은 Develop을 기준으로 한다.
2. Feature 브랜치에서 작업을 신나게 한다. (Feat/login)
3. 깃허브에서 Develop <- Feature PR을 생성, 코드리뷰 후 Develop <- Feature merge [이때 build Action]
4. 어느 정도 배포 할 때가 되었으면, Develop 브랜치를 기준으로 release 브랜치를 생성한다. (Release/1.1.12)
5. Release 브랜치에서 버저닝과 QA를 진행한다.
6. 깃허브에서 production <- release PR을 생성 후 merge [이때 Release & Tag Action]
7. 터미널에서 Develop <- production 백 머지

git-flow 참고 자료

• https://techblog.woowahan.com/2553/
• https://medium.com/corca/%EC%8B%A4%EB%AC%B4%EC%97%90%EC%84%9C-%EC%82%AC%EC%9A%A9%EB%90%98%EB%8A%94-git-flow-%EC%82%AC%EC%9A%A9%EB%B2%95-aka-app%EA%B0%9C%EB%B0%9C%EC%97%90-%EC%93%B0%EC%9D%B4%EB%8A%94-git-flow-%EB%B8%8C%EB%9E%9C%EC%B9%AD-%EC%A0%84%EB%9E%B5-9e860d7ce771
• https://icerabbit.tistory.com/55

Basic

1. 작은 기능 하나 구현 할 때 마다 커밋하기
2. 선 issue 발행 -> 후 feature 브랜치에서 작업
3. PR은 작업 분량으로 정상작동 내용이 있다면 머지하는 식으로 작은 단위의 작업
4. PR은 작업이 끝나서 리뷰를 받을 수 있는 상황 / 아닐 시에는 draft PR

Branch name

• 형식: feature/{구현 기능}
• 예시: feature/review, feature/login, feature/main ...

브랜치를 새로 생성할 때에는 develop 브랜치를 기점으로 생성하기

Commit Message

• 형식: 작업유형: 작업내용
• 예시: add: login 파일 추가, feat: login 로직
• 작업 유형
  • 파일 추가 : add
  • 버그 수정 : fix
  • 리팩터링 : refactor
  • 파일 삭제 : remove
  • 기능 추가 : feat
  • 문서 수정 : docs
  • 주석 추가 : comment
• 작업 내용은 한국어/영어 상관 없음
• 작은 기능 하나 구현 할 때 마다 커밋하기

Issue Title

• 형식: [작업유형] 작업내용
• 예시: [Feat] 리뷰 목록

PR Title

• 형식: [작업유형/#이슈번호] 작업내용
• 예시: [Feat/#59] 리뷰 쓰기 구현 완료