BE

• Main브랜치를 정말 깔끔하게 유지해야한다.

  • PR, 코드리뷰 신경쓰기
  • ESLint로 console.log() 적으면 경고뜨게 만들기

• front와 back

  • 이슈를 백엔드 프론트엔드 나눠서 상세하게 작성한다.
  • 이슈 넘버를 브랜치명 앞에 붙임으로써 구분할 수 있다.

• branch 구조

  • main - 배포용. 최상단 브랜치
  • develop - 개발 통합용
  • feature/* - 개발 피쳐별 브랜치
  • fix/* - 버그 수정 피쳐별 브랜치
  • refactor/* - 리팩토링 브랜치

  

  1. dev → [feat | fix | refactor]/${JIRA issue key}-${기능이름} → pr → develop
  2. main -> develop -> main
  
  ex) feat/50-login, fix/51-login-error
  
  feat/ATR-30-login
  

  PR Template

  ## ⚙️ PR Type
  
  - [ ] Bugfix
  - [ ] Feature
  - [ ] Code style update (formatting, local variables)
  - [ ] Refactoring (no functional changes, no api changes)
  - [ ] Build related changes
  - [ ] CI related changes
  - [ ] Documentation content changes
  - [ ] Other... Please describe:
  
  <br/>
  
  ## 📑 Related JIRA Epic(Issue)
  
  -
  
  <br/>
  
  ## 🔑 Key Changes
  
  -
  
  <br/>
  
  ## 🤝🏻 To Reviewers
  
  -
  
  <br/>
  

  Commit Convention

  # <type>: <subject>
  ##### Subject 50 characters ################# -> |
  
  # Body Message
  # 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
  ######## Body 72 characters ####################################### -> |
  
  # Issue Tracker Number or URL
  
  # --- COMMIT END ---
  # Type can be
  #   feat    : new feature (코드 추가, 수정)
  #   fix     : bug fix  (버그 수정)
  #   remove  : 불필요한 코드 삭제 (코드 삭제)
  #   refactor: refactoring production code (기능 변경 x)
  #   style   : 코드 의미에 영향을 주지 않는 변경사항 (형식 지정, 세미콜론 누락 등)
  #   docs    : 문서의 추가, 수정, 삭제
  #   test    : 테스트 추가, 수정, 삭제
  #   chore   : 기타 변경사항 (빌드 부분 혹은 패키지 매니저 수정사항)
  # ------------------
  # Remember me ~
  #   제목 첫 글자를 대문자로
  #   Use the imperative mood in the subject line
  #   제목 끝에 마침표 금지
  #   Separate subject from body with a blank line
  #   본문은 "어떻게" 보다 "무엇을", "왜" 를 설명한다.
  #   Can use multiple lines with "-" for bullet points in body
  # ------------------
  

  [BE Commit] 예시

  [ATR-99] feat: 새로운 기능 추가