Skip to content

팀 규칙

ryuseongryong edited this page Aug 4, 2021 · 7 revisions

node & npm 버전 통일

  • Node v15.14.0
  • NPM v7.20.0

commit log 양식

파일명-수식어-내용

예시: signin.js-Fix-로그인 기능 수정했습니다. 많은 파일을 수정했을 경우, 주요 파일, 내용만 commit log로 만들고, PR 내용에 나머지 파일, 내용을 입력한다.

  • 수식어 종류
    • Add → 새로운 것 추가
    • Delete → 삭제
    • Move → 이동
    • Fix → 버그 수정
    • Rename → 변수명/파일명 변경
    • Modify → 일반 수정

branch 이름 형식

  • feat + 기능명 (camelCase, ex) featLogin)

PR Rule

  • 아침 9시, 오후 5시에는 정기적으로 PR을 하기로 한다.
  • 그 외 필요한 PR이 있을 때 요청하고, 팀원들과 함께 PR을 하고 Merge한다.

Coding Rule

  • VSCode 설정

    • tab size 4
    • prettier 사용 X
  • 함수

    • 모든 기능을 함수로 나누기
    • 최대한 작은 단위로, 재사용 가능하게, 독립적으로
    • 컴포넌트를 함수로 작성할 때 : 함수 표현식 사용(화살표 함수 X)
    • 내부 함수를 작성할 때 : 화살표 함수 사용, const사용
  • 변수

    • 기본 선언문은 const로 정하고, const로 사용이 불가능한 경우 let을 사용
    • 환경변수명 : 스네이크 케이스(SNAKE_CASE)
    • 컴포넌트, 컴포넌트 파일 이름 : 파스칼 케이스(PascalCase)
    • CSS 클래스명 : 카멜 케이스(camelCase)
    • 그 외: 카멜 케이스(camelCase)
    • 파라미터 또한 누구나 알아볼 수 있게 작성 e.g.) event.target(o) e.target(x)
  • 줄맞춤

    • 시작하는 명령문을 한 칸 내려서 위의 명령문과 줄을 맞춘다. e.g.) else를 쓰려면 if와 같은 줄에 쓴다.
  • 주석

    • 주석으로 변수 설명
    • 타인이 알아보게끔 코드를 정리(가독성을 최대한 좋게)
    • 다른 사람이 봤을 때 잘 모를 것 같으면 주석 작성

커뮤니케이션

  • 소통은 정규 시간을 중심으로 진행한다.
  • 아주 급한 경우가 아니라면 정규 시간 외 연락을 최대한 자제하기로 한다.
  • 아주 급한 경우가 아니라면 최대한 빠르게 답변하기로 한다.
  • 체력관리를 잘하기로 한다.
  • 각자의 방식으로 기록을 하기로 한다.
  • 8월 16일은 각자 작업한다!