Skip to content

작업 컨벤션

Ji Yoon Choi edited this page May 5, 2022 · 4 revisions

컨벤션

HTML, CSS, JS 코딩 스타일

  • 미리 설정되어 있는 Eslint, Stylelint, Prettier에 따름

컴포넌트명, 함수명

  • 컴포넌트명은 대문자로 시작 (PascalCase)
  • 함수명, 변수명은 소문자로 시작 (camelCase)
  • 상수명은 모두 대문자 (CONSTANT)
  • 폴더명, 컴포넌트명, 함수명은 강사님의 네이밍에 전적으로 따르기

핸들러 이름

  • handle[태그명, 컴포넌트명][이벤트명]
  • 태그명, 컴포넌트명은 같은 이벤트에 대해 여러 개의 핸들러가 필요할 때 구분용으로 사용
  • 예시: handleChange (중복된 이벤트가 없을 경우)
  • handleEmailChange, handlePasswordChange (중복된 이벤트 - onChange - 가 있을 경우)
  • props로 넘겨줄 땐 on~ 을 사용
  • 예시: onEmailChange, onPasswordChange

export default 관련

  • 맨 아래에 export 하기

Git Flow 관련

  • main에서 dev 브랜치만 작성, dev 브랜치에서 기능별로 분리하기
  • Pull Request는 각 브랜치에서 dev 브랜치로 날리기

브랜치명

  • Feat/[기능명]
  • 예시: Feat/MainMenu
  • 엄격하게 지킬 필요는 없음

PR 알림

  • 깃허브 웹훅으로 디스코드에 연결하여 알림 오도록 설명하면 좋을 듯

PR 머지 규칙

  • 3명의 리뷰를 받아야 (Apporoved) 머지 가능
  • 서로 코드를 읽어보고 리뷰를 달아야 서로의 코드를 익히기 쉬움

커밋 코멘트

image

  • 위의 접두사를 붙여 작명하기
  • 예시: Feat: 메뉴에 프로필 컴포넌트 추가