3. 개발 룰 - woowa-techcamp-2021/store-4 GitHub Wiki

Github

커밋

  • 작은 단위로 하려고 노력합시다! 리뷰어를 배려하는 커밋
  • ${prefix}: 내용은 한글로 작성
    • 설명은 필요한 경우에
  • Prefix
    • add: 기능을 만들 때 필요한 작은 요소들 (스타일링, 일부 로직.. 등)
    • fix
    • docs
    • wip: 아직 작업 중일 때
    • chore

브랜치명

  • ${prefix}/브랜치명 (feat, fix, docs, chore)
  • 이슈를 발행할 때 브랜치명도 같이 정하기

이슈 형식

  • 공통적으로 들어갈 내용: 브랜치명, 예상시간
  • 이슈 내용은 자유롭게 쓰되 다른 사람도 충분히 이해할 수 있도록
  • 이슈 발행을 어떤식으로 할지는 애자일, 기획서 등 나오면 다시 이야기하기

PR

  • 제목: [#이슈번호] 설명
  • 공통적으로 들어갈 내용: 관련 이슈, 실제 소요시간
  • 내용은 이슈와 마찬가지로 자유롭게, 설명도
  • 연결된 이슈 등록 가능

컨벤션

  • webpack, babel, eslint, prettier, tsconfig 등 같이 설정
  • eslint 기본값으로 우선 설정. 하다가 불편한 점이나 추가하고 싶은 룰 생기면 바꿔나가는 걸로
  • prettier는 공통으로 설정 또는 각자 쓰는대로 하고 커밋 전에 양식 통일?
  • 네이밍
    • 변수명: camelCase
    • 컴포넌트 파일명 / 클래스: PascalCase
    • 컴포넌트가 아닌 파일명: camelCase
    • 서버 파일명: kebab-case
    • 컴포넌트 작성 시 규칙
      • 로직(Container) / 뷰(Component) 분리
      • 네이밍(styled-component) - 역할과 같이
      • Container 최상단에 한번만이니까 prefix 없이
      • styled 컴포넌트'만' 사용하기
      • Component의 props는
        • 그냥 Props
        • Component 선언 바로 위에
      • styled-components
        • 각각 위에 props
        • Prefix 붙이기