👨‍💻컨벤션

Github convention

: 도현님이 담당해서 관리

커밋 메시지

: 라벨: 커밋 내용[한글|] - #isssueNum → git commit -m “feat: - #19”

• 라벨
  • feat: 새로운 기능 추가 (기본 UI작업도 포함 )
  • fix: 버그 수정
  • docs: 문서 수정
  • refactor: 코드 리팩토링
  • test: 테스트 코드
  • chore: 패키지 매니저 수정, 코드 포맷팅
  • build: 초기 개발 환경 설정, 깃헙 액션, 도커 관련된 파일 수정
• 타이틀 내에서 남기되 추가로 바디에는 이유만 남기기
• 커밋 내용은 한글 최대 50자 이내로 작성하고 동사 및 명사로 마무리
• https://overcome-the-limits.tistory.com/6

브랜치

• git-flow를 기반으로 사용하되 main, develop,feature 중심으로 사용
• develop에서는 에러 존재 가능함을 전제해서 머지하고 main은 최종 에러 다 수정해서 머지하고 외부 공개
  • 네이밍 : feature/작업_이니셜 → feature/login_kmh
• 머지된 브랜치는 원격 저장소에서 반드시 삭제하기!!

이슈

• 깃헙 이슈에 등록할 라벨
  • FEAT
  • T_SHOOT
  • BUG
  • RELEASE (PR용)
  • BE
  • FE
  • DOCS
• 백로그 작성한 뒤 이슈에다가 쭉 다 등록
  • 네이밍 : [#BacklogNUm] 작업내용 + 깃헙 이슈 라벨
• 관련 기능 작업하다가 추가적으로 발생한 트러블슈팅 및 버그 관련
  • 네이밍 : [라벨] 작업내용 + 깃헙 이슈 라벨
• 이슈별 템플릿 작성해놓고 그 안에서 작성
• PR
  • 템플릿 작성해서 그 안에서 틀에 맞춰서 작성
  • 담당 도현님이 작성하고 이후에 팀원들 동의 하에 추가 수정 및 확정

Code Convention

변수명

• CamelCase
• 상수 : SnakeCase + All 대문자 → MY_PROJECT_PORT
• Boolean : is + 대상 + 상태 → isLoadSuccess
• Array : ~~List로 표현하기, Literal로 사용 → []
• Object, Map : Obj, Map을 뒤에다가 붙여주기, Literal로 사용

함수명

• CamelCase
• getter와 setter는 각각 get과 set으로 시작하기
• 동사로 시작하기
  • 이벤트 핸들러에 등록하는 함수는 handle + 관련 이벤트 + handle함수는 따로 선언해서 빼놓기 + 한줄까지 허용!

HTML

• 시맨틱 태그 최대한 활용하기
• 에디터? 내용 논의에서 추후 발전하기

File Naming Convention

• 폴더명은 항상 복수 + all 소문자

• 이미지/ 아이콘 구분 : img_, ico_

• 리액트 컴포넌트 폴더 구조 : pages + components

  • layout 관련된 스타일은 layout.ts 파일에

    styles

    ㄴ layout.ts

• 파일명: index로

• style 파일 분리

  e.g) Modal

  ㄴ index.tsx

  ㄴ styled.ts

• 두 개 이상의 페이지에서 사용되는 컴포넌트는 common으로

  e.g) common

  ㄴ Modal

  ㄴ 모든 모달 컴포넌트들