Reviewing 컨벤션

[ohseil]

branch 컨벤션

스프린트 주기에는 main이 아닌 dev 브랜치에 개발한다.
develop에서 main으로 merge는 스프린트 마지막날!

1. branch 전략

Issue 등록시 자동 생성
예) label과 assign을 포함한 글을 등록하게되면 feature label 일경우
BranchName: "feature/{#issue_num}"
PR작성후 Merge를 진행하면 Issue > close, branch는 자동삭제 됨

PR진행시 다른 팀원에게 코드 리뷰를 받은 후 approve가 되면 feature/subscription을 develop 브랜치에 스쿼시 머지한다.

• 기능 브랜치를 develop 브랜치에 머지하는 경우엔 스쿼시 머지
• develop 브랜치를 main 브랜치에 머지하는 경우(배포일)엔 일반 머지

ISSUE 컨벤션

기능 구현 ISSUE 컨벤션

1. ISSUE 제목

이슈 제목은 "간단 설명" 형식에 맞게 작성한다.
예) 이슈 제목은 "구독 기능을 구현한다."

2. label

• feature : 기능 구현
• refactoring : 리팩터링
• fix : 버그 개선
• document : 문서 작성
• test : 테스트
• ci : CI 관련 설정
• cd : CD 관련 설정
• deployment : 배포 관련 설정

3. assignee

기능 구현 담당한 사람(본인)을 assignee에 추가

4. ISSUE 내용

## 구현 기능

## 작업 내용

## 주의 사항

위와 같은 형식으로 작성한다.
물론, 주의 사항은 선택적 작성

commit 컨벤션

커밋 컨벤션은 "type: 설명" 형식으로 한다. type은 아래와 같다.

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 관련
• style: 스타일 변경 (포매팅 수정, 들여쓰기 추가 등)
• refactor: 코드 리팩터링
• test: 테스트 관련 코드
• build: 빌드 관련 파일 수정
• ci: ci 설정 파일 수정
• cd: cd 설정 파일 수정
• chore: 위에 해당하지 않는 애매하거나 자잘한 수정

예시

• README.md를 수정하면 문서 관련이므로 "docs: README.md 수정"과 같은 형식으로 작성.

PR 컨벤션

ISSUE 컨벤션과 거의 비슷하다. 다른점은

1. PR 제목

해당 기능을 구현하기 위해 만들었던 이슈 번호를 이용하여,
"[#이슈번호] 작업 설명" 와 같은 형식으로 작성한다.
예를 들어 구독 기능 이슈가 23번이면 "[#23] 구독 기능 구현"