Conventions

Code convention

Components

• 컴포넌트는 함수 선언식. 이 외에는 화살표 함수로.

명명

• 변수, 상수, 함수 이름 축약 없이 구체적으로 명시 e.g. HandlePasswordOnBlur (O) HandlePWDOnBlur (X)
• 상수는 모두 대문자로 _ 연결하여 작성 const AXIOSINSTANCE_TIMEOUT = 3000
• 훅은 use로 시작, 데이터 가져오는 함수는 get으로 시작, 이벤트 핸들러는 handle로 시작
• 이벤트 인자는 event (O) e (X)
• useState의 setter callback 함수는 (prev) => {} (O) (curr) => {} (X) (current) => {} (X)

Export rules

• 컴포넌트는 export default , 변수 함수 훅들은 export

Branch rules

• Branch naming : 기능-이름
• PR naming : 지선-탬플릿

merge rules

• 한 명 이상 승인하면 머지

Commit convetion

• Type
  • Feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
  • Fix : 기능에 대한 버그 수정
  • Style : 코드 스타일, 포맷팅에 대한 수정
  • Refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
  • Design : css 수정
  • Docs : 문서 수정
  • Chore : 빌드 관련 파일, 패키지 매니저 수정 (.gitignore or build.gradle)
• Commit message : 첫 글자 대문자