Project Convention

본 프로젝트 개발 진행 시, 작업 진행 플로우, 브랜치 규칙, 커밋 메시지 규칙 등 전반적인 프로젝트 컨벤션에 대한 내용을 정리한다.

작업 진행 플로우

작업은 크게 Issue 생성 → 작업 진행 → PR 생성 → Merge의 단계로 이루어지며, 자세한 내용은 아래와 같다.

1. Issue 생성
2. Issue에 대한 브랜치 생성
   • 이슈_타입명/ISSUE_NUMBER-작업_키워드로 브랜치 생성
3. 해당 브랜치에서 작업 진행
4. 작업 완료 후 Pull Request 생성
   • Reviewer: 지정 X
   • Assignee: 작업자 지정
   • Label: 작업한 내용에 맞게 지정
5. Merge

브랜치 규칙

Issue에서 이슈_타입명/ISSUE_NUMBER-작업_키워드로 브랜치를 생성하여 작업한다.

커밋 메시지 규칙

커밋 메시지는 TYPE: COMMIT_MESSAGE #ISSUE_NUMBER형식으로 작성한다.(예시: feat: convention 추가 #1)

Tag Name	Description
feat	새로운 기능을 추가
fix	기능 변경
bug	버그 수정
refactor	프로덕션 코드 리팩토링
docs	문서 수정
test	테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
cicd	cicd 관련