🤝 Convention

[sol-pine]

Git Flow

• feat/(dev name) : feature branch
• refac/(dev name) : refactoring develop branch
• fix/(dev name) : debugging branch
• refactoring : refactoring branch
• main(master) : release branch

Git Convention

Commit 메시지

• 기본적인 커밋 메시지 구조는 제목, 본문 두가지 파트로 나누고, 각 파트는 한 줄을 두어 구분한다.
• Type, Subject
  • 제목은 최대 50글자가 넘지 않도록 하고 특수기호는 사용하지 않는다.
  • 영문으로 표기하는 경우 이모지를 가장 앞에 두고 메시지를 소문자로 표기한다.
  • 제목은 개조식 구문(완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미)으로 작성한다.
  • fix. 버그 수정
• Body (option)
  • 본문은 커밋 상세 이유를 작성한다.
  • 한 줄 당 72자 내로 작성한다.
  • Title과 Body사이에는 공백 한 줄을 두고 작성한다.

Git 규칙

• Git Convention은 반드시 숙지하고 지켜주세요.
• 안쓰는 코드들(콘솔, 주석)은 쌓아두지 말고 지워주세요.
• Pull → Commit → Push 순서로 작업해주세요.
• push 전 에러가 안나는 지 먼저 확인하고 push 후에는 PR 합니다.
• PR을 거쳐 모든 팀원들이 승인 후, merge 합니다. conflict 해결은 모든 팀원이 함께 참여해요!

Commit Message Prefix

• feat. 기능 및 CSS 추가, 삭제, 변경 - 코드 수정 발생 시
• fix. 버그 수정 - 코드 수정 발생 시, 디버깅 시
• docs. 물리적인 파일 추가, 파일명 삭제, 파일명 변경 - 기본 코드 작성하고 커밋
• refactor. 코드 리팩토링 ex) renaming a variable - 코드 수정 발생 시
• chore. 패키지, 라이브러리 설치 - 코드 수정 없음

Convention

• 폴더명 : camelCase
• 파일명 : PascalCase(tsx), camelCase(그 외)
• 컴포넌트명 : PascalCase
• 변수명 : camelCase
• 전역 상수명 : 대문자 snake_case
• scss 변수명 : snake_case
• className: snake_case
• 함수명 : 동사로 시작
• 커스텀훅 : use로 시작

폴더 구조

ㄴ 📁 components
   ㄴ 📁 common // 2개 이상 페이지에서 재사용되는 컴포넌트
   ㄴ 📁 main // 사용되는 페이지로 구분
      ㄴ 📄 MainBanner.tsx
      ㄴ 📄 MainProducts.tsx
ㄴ 📁 elements // 공통 엘리먼트
ㄴ 📁 pages // 페이지 컴포넌트
ㄴ 📁 constants // 전역 상수
ㄴ 📁 hooks // 커스텀 훅
ㄴ 📁 query // 쿼리 훅
ㄴ 📁 redux // redux
ㄴ 📁 shared 
   ㄴ 📁 api
   ㄴ 📁 types // 전역 타입 
   ㄴ 📁 style // GlobalStyle,theme,style.d.ts
   ㄴ 📁 utils // 유틸 함수
ㄴ 📁 style // 컴포넌트 style