컨벤션을 지키면 ...

1. 커뮤니케이션이 추상화된다.
2. 코드 작성자에게 직접 묻지 않아도 문서를 통해 작업 현황을 알 수 있다.

1️⃣ Git Branch

• main : 제품 출시 브랜치
• develop : 출시를 위해 개발하는 브랜치
• feat/{기능명} : 새로운 기능 개발하는 브랜치
• refactor/{기능명} : 개발된 기능을 리팩터링하는 브랜치
• hotfix : 출시 버전에서 발생한 버그를 수정하는 브랜치

• 예시
  • main
  • dev/feat/login
  • dev/feat/register

2️⃣ Commit

[Git] Git Commit Convention, 깃 커밋 컨벤션 참고

• 예시
  • Feat: "Add 이미지 검색"
    네이버 이미지 검색 API 연동
    Related to: #1
  • Test: "Add 지역 검색 테스트"
    네이버 지역 검색 API 연동 테스트 코드 작성

3️⃣ Issue

• 담당자(Assignees) 명시하기
• Task list 기능을 적극 활용하기
• 기능에 관련된 Issue라면 Github Project와 PR과 연동하여 진행상황 공유하기

• 예시
  • [FEAT] 네이버 이미지 검색 API 연동
    • TODO
      [ ] 네이버 이미지 검색 API 연동하기

4️⃣ Pull Request(PR)

• [키워드] #[해당 이슈 번호] 작성
• 키워드
  • close, closes, closed- fix, fixes, fixed- resolve, resolves, resolved

• 예시
  • close #7
  • 나는 제목은 따로 작성하고, [키워드] #[해당 이슈 번호]를 body에 적어주었다
    

---

출처
Github Convention 깃헙 컨벤션 정리/모음