Github & Git 컨벤션

Table of Content

• 커밋 컨벤션
• pr컨벤션
• 마일스톤
• 이슈 템플릿

---

Commit 컨벤션

제목과 본문을 한 줄 띄워 분리, 제목은 아래 convention에 따르고 본문은 필요한 경우 작성

제목 형식

Feat : 새로운 기능 추가
Fix : 버그를 고친 경우
Refactor : 코드 리팩토링
Design: css 등 사용자 ui 디자인 변경
Style : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없는 경우
Build : 빌드 관련 파일 수정
Chore : 기타 변경사항(빌드 스크립트 수정 등등)
Comment: 필요한 주석 추가 및 변경
Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove: 파일을 삭제하는 작업만 수행하는 경우
Docs : 문서 수정
Test : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없는 경우)

PR 템플릿

## 제목 + #이슈넘버
ex) github oauth 구현 #1 

## 요약 (개요)
요약을 적으면 됩니다

## 작업 내용(to-do list)
[x] 완료 목록 
[ ] 진행 중 목록

## 주의 사항
주의사항을 적으면 됩니다

## 테스트 결과
테스트 결과를 넣으면 됩니다

## 이슈 태그
관련된 이슈를 모두 태그하면 됩니다. 
ex) #3 #1

마일스톤

• 서비스 단위

예시: 로그인 구현하기

# 목적

## 세부내용

이슈 템플릿

• 마일스톤에 해당하는 세부적인 기능

예시:

• oauth 구현 (be, feat)
• user 댓글 create (be, feat)
• oauth 구현 (fe, feat)

## 제목
제목 적기

## 요약 (개요) 
* 요약을 적으면 됩니다.

## 주의 사항 
주의사항을 적으면 됩니다.