브랜치 명명법, 커밋메시지구조, PR 명명법, 이슈 → 지라 참고용

branch 명명법

main 메인 브랜치
develop 개발 브랜치
feat/엔티티명 기능 개발 브랜치 feat/order
feat/user
feat/comment
feat/todo
test/엔티티명 테스트 브랜치 test/order
test/user
test/comment
test/todo

모든 브랜치 명은 소문자 사용

feat/order

Commit Message 구조

type(타입) - title(제목) EX] git commit -m “[SI-4] feat : login”

기본 규칙

Type 키워드 사용 시점
feat 새로운 기능 추가
fix 버그 수정
docs 문서 수정
style 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우
design 사용자 UI 디자인 변경 (CSS 등)
test 테스트 코드, 리팩토링 테스트 코드 추가 (Test Code)
refactor 코드 리팩토링 (Production Code)
build 빌드 파일 수정
ci CI 설정 파일 수정
perf 성능 개선
chore 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
rename 파일 혹은 폴더명을 수정만 한 경우
remove 파일을 삭제만 한 경우

대부분 가장 많이 사용하는 것은 feat와 fix


Pull Request 남길때

[PR 생성 및 Merge 알림은 Slack으로]

  1. develop(main)으로 푸시하기 전에 테스트 다 하셔서 문제 없는것 확인
  2. 한 기능(하나의 서비스가 전체적 동작이 완료되는 것)이 완료 되면 푸시하기