Git Branching Strategy

Github Repository

https://github.com/woowacourse-teams/2024-pengcook

커밋 컨벤션

• 커밋 타입은 깃모지를 사용해요
• 커밋 메시지, PR title, PR description은 영어로 통일해요
• PR comment는 한글로 작성해요
• PR주기는 기능 단위로 해요 (분야별로 권한 위임)
• 커밋 메시지 title은 50자 이하로 작성해요
• 커밋 스코프는 생략해요

브랜칭 전략

브랜치명 양식

*은 항상 유지되는 브랜치이며, 해당 브랜치에서는 커밋을 하지 않는다.

• **main ***
• **an/prod ***
• **be/prod ***
• an/release
• be/release
• **an/dev ***
• **be/dev ***
• an/feat/[issue-number]
• be/feat/[issue-number]

브랜치 생성 및 활용 과정

1. 각자 Task에 따른 Issue를 생성한다. → 이슈 번호가 숫자로 생성됨

2. dev 브랜치로부터 feat 브랜치를 생성하여 개발을 진행한다.

   브랜치 생성 시, 생성된 이슈 번호를 토대로 브랜치 이름을 설정한다.

   [position]/feat/[issue-number]

   git checkout an/dev git fetch origin an/dev git rebase origin/an/dev git checkout -b an/feat/126

3. 각자 기능 개발을 마친 후 PR을 아래 브랜치 방향대로 작성한다. an/dev ← an/feat/123

   PR 작성 이전 로컬에서 dev 브랜치를 pull한다.

   <aside> 💡 이때 pull은 rebase가 아닌 merge 형태로 한다 (git config pull.rebase false)

   </aside>

4. 해당 PR에 대해 코드 리뷰를 완료한 뒤 PR을 reabse한다. (Merge 나 Squash 는 적용하지 않는다.)

   이 과정에서, rebase를 적용한다.

   Rebase되면, 해당 브랜치는 삭제한다.

5. 목표 단위까지의 개발이 완료되면 배포 준비를 위해 release 브랜치를 생성한다. git checkout -b an/release

6. 릴리스에서 전체 테스트를 진행하는 동안 문제 발생 시, Hotfix로 수정 사항을 반영한 후 dev 브랜치로 병합한다. Commit message 🚑 :ambulance: resolve some problem

7. release 브랜치에서 모든 테스트를 통과하여 배포 준비가 완료되면 PR을 아래 브랜치 방향대로 작성한다. an/prod ← an/release

   1. PR 병합 시 Squash 를 통해 커밋 이력을 하나로 통합한다.

   2. 만약 prod 브랜치에서 문제가 발생하면 6번 과정으로 돌아간다.

   3. 수정된 release 브랜치 상에서 문제를 해결하면, 아래와 같이 다시 dev 브랜치에 병합한다.

      an/dev ← an/release

8. prod 브랜치에서 모든 준비가 완료되면, PR을 아래 브랜치 방향대로 작성한다.

   main ← an/prod

   1. main 브랜치에 PR을 진행할 때는, 아래와 같은 PR명 컨벤션을 따른다.

      release v1.0.0

   b. PR 병합 시 rebase 으로 머지한다.

9. 이후 새로운 기능 개발 시, 1번 과정으로 돌아간다.

브랜치명 컨벤션

• feature : 새로운 기능 추가
• fix : 버그 수정
• refactor : 코드 리팩토링
• build : 빌드 관련 파일 수정
• ci : CI 설정 파일 수정
• cd : CD 설정 파일 수정
• perf : 성능 개선
• chore : 그 외 자잘한 수정

깃모지

https://gitmoji.dev/

아이콘	코드	설명	원문
✨	✨	새 기능	Introduce new features.
♻️	♻️	코드 리팩토링	Refactor code.
🔥	🔥	코드/파일 삭제	Remove code or files.
🐛	🐛	버그 수정	Fix a bug.
✅	✅	테스트 추가/수정	Add or update tests.
📝	📝	문서 추가/수정	Add or update documentation.
💄	💄	UI/스타일 파일 추가/수정	Add or update the UI and style files.
➕	➕	의존성 추가	Add a dependency.
➖	➖	의존성 제거	Remove a dependency.
🔧	🔧	구성 파일 추가/삭제	Add or update configuration files.
⏪	⏪	변경 내용 되돌리기	Revert changes.
🚚	🚚	리소스 이동, 이름 변경	Move or rename resources (e.g.: files paths routes).
💡	💡	주석 추가/수정	Add or update comments in source code.
🎉	🎉	프로젝트 시작	Begin a project.
💩	💩	똥싼 코드	Write bad code that needs to be improved.
🍻	🍻	술 취해서 쓴 코드	Write code drunkenly.