🚧진행중

🏭 Architecture

🌊Flow

Git Convention

Convention을 지키는 이유는 추후 팀 프로젝트를 진행 시 원활한 협업을 하기 위한 연습입니다.

2024-09-13 이후 적용

Branch

머릿말	설명
main	서비스 브랜치
release	배포 전 작업 기준
feature	기능 단위 구현
hotfix	서비스 중 긴급 수정 건에 대한 처리
BE	백엔드 개발 부분

Commit

태그 이름	설명
Feat	새로운 기능을 추가할 경우
Fix	버그를 고친 경우
Design	CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment	필요한 주석 추가 및 변경
Docs	문서를 수정한 경우
Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore	빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우

commit 작성 시 제목, 본문, 꼬리말 분리해서 작성❗❗❗

제목은 어떻게 적는가?

1. 제목의 처음은 동사 원형으로 시작합니다.
2. 총 글자 수는 50자 이내로 작성합니다.
3. 마지막에 특수문자는 삽입하지 않습니다. 예) 마침표(.), 느낌표(!), 물음표(?)
4. 제목은 개조식 구문으로 작성합니다. 

예시)
Feat: "추가 get data api 함수"

본문은 어떻게 적는가?

1. 본문은 한 줄 당 72자 내로 작성합니다.
2. 본문 내용은 양에 구애받지 않고 최대한 상세히 작성합니다.
3. 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명합니다. 

꼬리말은 어떻게 적는가?

1. 꼬리말은 optional이고 이슈 트래커 ID를 작성합니다.
2. 꼬리말은 "유형: #이슈 번호" 형식으로 사용합니다.
3. 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.
4. 이슈 트래커 유형은 다음 중 하나를 사용합니다.
    - Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
    - Resolves: 이슈를 해결했을 때 사용
    - Ref: 참고할 이슈가 있을 때 사용
    - Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
ex) Fixes: #45 Related to: #34, #23

예시

Feat: "추가 로그인 함수"  ---- 제목

로그인 API 개발           ---- 본문

Resolves: #123             ---- 꼬리말
Ref: #456
Related to: #48, #45

좋은 커밋 메시지를 남기기 위한 7가지 요약

1. 제목과 본문을 한 줄 띄워서 구분합니다.
2. 제목을 50글자 이내로 제한합니다.
3. 제목 첫 글자는 대문자로 작성합니다.
4. 제목 끝에 .(마침표) 넣지않습니다.
5. 제목은 명령문으로 사용하고 과거형을 사용하지 않습니다.
6. 본문의 행마다 72글자 이내로 제한합니다.
7. 본문은 어떻게 보다는 무엇과 왜를 설명하며 작성합니다.