Rules

Gitflow

• Branch 구성

  • 메인 브랜치 (프로젝트 기간동안 사라지지 않음)
    • main (only release)
    • develop (default)
  • 서포팅 브랜치 (필요에 따라 생기고 삭제됨)
    • 태그/작업내역 형식
      • feature/{이슈번호}-{작업내역}

      feature/1-login
      

• 작업 플로우

  • issue로 작업 내용 작성
  • 서포팅 브랜치 생성 후 개발
  • 완료 시 develop 브랜치로 Pull Request

• Pull Request

  • 코드리뷰 필수

• merge

  • develop 브랜치에 rebase merge

---

Commit Rules

• 양식

  • 태그

    feat : 신규 기능 개발
    refactor : 리팩토링
    style : 로직 변경없이 개행이나 스타일 수정만
    test : 테스트 코드 작성 및 수정
    fix : 버그 수정
    docs : 문서(readme 등) 작성 및 수정
    chore : 빌드환경, 패키지 수정
    

    {태그} : {제목}
    
    - {세부내용}
    - {세부내용}
    
    ref : {이슈번호}
    

---

Code Rules

• 네이밍 규칙 (자세한 내용)
  • 변수 및 함수
    • camelCase 방식을 사용
    • 변수에 모든 의미를 충분히 담을것
• 패키지 구조
  • 도메인형으로 작성

    ㄴ main
     ㄴ domain
     |  ㄴ user
     |  |  ㄴ controller
     |  |  ㄴ service
     |  |  ㄴ domain
     |  |  ㄴ dto
     |   ...
     ㄴ global
       ㄴ error
       ㄴ util