- main 브랜치: 배포용
- develop 브랜치: 개발용
- {개인 브랜치명}: 기능 개발용
- issue는 작업 계획이나 작업 결과 공유를 위해 사용하며, 새로운 페이지 및 주요 기능 개발 시 작성 권장하고 todo 작성으로 진행 정도를 확인합니다
- pr은 코드 리뷰 후 merge를 위한 것이라면, issue는 팀원들끼리 작업 완료 정도 혹은 작업 계획 정도 체크 소통을 위한 것 입니다
- 적절한 템플릿 선택
- 관련 라벨 부착 (우선순위, 상태, 유형)
- 구체적인 설명과 체크리스트 작성
- "In Progress" 라벨로 변경
- 커밋 메시지에 이슈 번호 포함
- 체크리스트 항목 실시간 업데이트
- "Review" 라벨로 변경
- 리뷰어 지정
- 테스트 결과/스크린샷 첨부
- 체크리스트 완료 여부 확인
- "Done" 라벨로 변경
- 관련 PR 연결
제목, commit 항상 "본인이 작성한 기능 : 내용 " 으로 통일 ex) my page 만든 것에 대한 pr 제목 - "feat : my page 구현"
- 이슈 번호: 관련 GitHub 이슈 번호 명시 - 이슈 있을 때 pr 제목 feat 옆에 이슈 번호 작성 / pr 문서 마지막에 이슈 번호 # 후 작성해서 언급해두기
- 요약: 변경 사항 간단 요약
- 작업 상세 내용: 구체적인 작업 내용 기술
- 이슈/의논 거리: 해결할 논의 사항 명시
- 리팩토링: 기능/버그 수정과 분리 진행
- 모든 코드는 리뷰 후 merge
- 팀원이 pr 올리면 코드 확인하기
- 오타 수정 등은 코드 리뷰 없이 바로 merge 가능
- 적극적인 질문과 소통
- package 설치 시 팀원들에게 알려주고 다른 팀원들은 해당 package 설치하기 (merge 시 충돌 방지)
- 제목/본문 빈 행으로 구분
- 제목 간단히, 무엇과 왜가 들어가게
- 제목 첫 글자 대문자
- 제목 끝 마침표 없음
// Header, Body, Footer는 빈 행으로 구분한다.
타입(스코프): 주제(제목) // Header(헤더)
본문 // Body(바디)
바닥글 // Footer
| 타입 | 설명 |
|---|---|
| ✨ feat | 새로운 기능 |
| 🐛 fix | 버그 수정 |
| 💄 style | 코드 스타일 수정 |
| ✅ test | 테스트 코드 수정 |
| ⚡ perf | 성능 개선 |