[DOCS] BE Code Convetion

[tigris24]

💭 ISSUE

• 노션의 업무보드 기준으로 Project 에 월요일 스크럼에서 1주~2주 단위로 작업 목록을 스프린트 단위로 작성해둔다.
• 이슈는 회의에서 작성된 것을 바탕으로 내용을 깔끔하게 정리한다.
  • 이슈를 너무 남발하면 관리가 제대로 되지 않음
  • 이슈 번호를 브랜치 생성 단위로 사용
    ex) docs/#1/BE-Code-Convention
• 이슈 제목
  ex) [DOCS] BE Code Convention
• labels 를 적극적으로 활용
  • 필요한 라벨 추가
• Issue Template 기준 작성

📣 COMMIT

1. [TAG] : Title
2. TAG는 영어로, 모두 대문자 형태로
   • TAG 종류
     • FEAT : 새 기능 추가
     • FIX : 버그 수정
     • HOTFIX : 긴급 버그 수정
     • REFACTOR : 리팩토링
     • TEST : 테스트 코드
     • STYLE : 코드 포매팅 수정(로직 수정은 없을 때)
     • DOCS : 문서 수정
     • SETTING : 개발 환경 수정 (ex. CI/CD)
3. 본문 내용은 최대한 자세히 (단, 이해가 쉽도록 문장 간소화)

🎉 PULL REQUEST

1. PR 타입 선택
   • 기능 추가
   • 기능 삭제
   • 버그 수정
   • 의존성, 환경 변수, 빌드 관련 코드 업데이트
2. 반영 브랜치 선택
   ex) feat/#1/login -> dev
3. 변경 사항 설명
   ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.
4. 테스트 결과
   ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

🔍 CODE REVIEW

1. 코드 리뷰는 항상 멘션해서 요청
2. 라벨을 이용해서 언제까지 리뷰가 완료되어야 하는지 알림
3. 리뷰 상세히 작성
   • 단순히 ~확인하였습니다 지양

🚦 BRANCH

• main : 배포 되어 있는 브랜치
  • dev : 다음 출시 버전 개발 브랜치
    • feat : 기능 개발 브랜치
    • fix : 기능 수정 브랜치
    • test : 테스트 코드 브랜치
  • hotfix : 긴급 버그 수정 브랜치
  • relase : 이번 출시 버전 준비 브랜치

[tigris24]

@Minju-Kimm @xorwns118

[Minju-Kimm]

PR 작성 시 라벨링