05. 컨벤션

Git 컨벤션

Branch 전략

gitlab-flow에 저희가 추가로 설정한 dev 브랜치 종류(feat, refactor)를 추가하였습니다.

참고) https://techblog.woowahan.com/2553/

• 종류
  • main : 제품 출시 가능 브랜치
  • release : 이번 출시 버전을 준비하는 브랜치
  • dev : 다음 출시 버전을 개발하는 브랜치
    • feat : 새로운 기능 개발
    • refactor : 기존 개발 리팩토링
  • hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치
• 예시
  • dev/feat/회원가입
  • dev/feat/로그인

Branch 네이밍 규칙

• {종류}/{issue-number}-{feature-name}
• 예시) feat/1/회원가입

Commit 규칙

<커밋 타입>[(옵션) scope]: <description>

[(옵션) body]

[(옵션) footer(s)]

// 예시

fix : prevent racing of requests
또는 fix(로그인) : prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Refs: #123

• 커밋 타입
  • fix : 버그 수정일 경우
  • feat : 새로운 기능 추가인 경우
  • chore : 코드 수정 없이 설정 변경
  • docs : 문서 수정인 경우
  • refactor : 리팩토링

Git Issue Label 규칙

• In progress
• hot fix

PR title 형식

• [#이슈번호] 요약

코딩컨벤션

• 구글 자바 스타일 가이드를 선택하여 적용하였습니다.
  링크
• Intellij plugin check style을 통해 커밋 시 코드 컨벤션 정리
  참고

Dto 클래스 네이밍

• Dto 를 suffix 로 한다