Skip to content

Team Rule

goni1621 edited this page Apr 22, 2022 · 3 revisions

Team Rules

  • 일정

    • 하루에 두번, 오전 오후에 개발회의를 가진다
    • 10:00 에는 자기가 어제까지 완료한 사항과 오늘 할 일정에 대하여 브리핑한다.
    • 17:00 회의에는 현재 자신이 작업한 부분에 대한 애로사항등을 회의에서 언급하며 토론한다
    • 점심시간은 12:00 ~ 13:00 이다.
    • 정규 프로젝트 시간은 10:30 ~ 19:00 까지이며, 이후에는 개인의 자율의사에 따른다.
  • 의사소통

    • 목표 일정은 최대한 완수하되, 애로사항 발생시에는 팀원들에게 적극적으로 도움을 요청한다
    • 일정이 하나 둘 딜레이되면, 일정 전부에 불편함을 끼칠 수 있기에 다른 팀원들의 양해를 구해 도움을 요청한다
  • 팀원 코드 작성 규칙

    • 프리티어를 사용한다.
    • 함수 생성시, 주석을 달아서 설명적는다.(/**/)
  • commit

    • 레포 merge는 10:30, 17:30 두번으로 진행하며, 반드시 모든 팀원이 함께 진행한다.
    • merge 할때는 팀원모두가 모였을때 상의 후 진행하며, 독단적으로 혼자 merge를 진행하지 않는다.
    • 새벽 등 다른 팀원들과 소통이 안되는 시간대에는 자신의 작업의 영향이 자신의 PC밖을 넘어서선 안된다.

커밋 메시지 규칙

커밋
  • 제목과 본문을 한 줄 띄워 분리한다.
  • 제목은 영문 기준 50자 이내로 적는다.
  • 제목 첫글자를 대문자로 적는다.
  • 제목 끝에 . 는 금지한다.
  • 제목은 명령어로 작성한다.
  • 제목은 과거형은 사용하지 않는다.
  • 본문은 50자마다 줄을 바꾼다.
  • 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성한다.
  • 본문은 한글 또는 영어로 작성한다.
  • Fix 된 파일이 있을시, Fix [Content.js] 와 같이 '[]' 의 형식으로 메시지를 작성한다

Lint 규칙

  • semistandard 를 따른다.(주요 규칙과 상이하는 부분이 있다면 주요규칙의 우선 순위가 높다) 주요규칙
  • space는 두 칸 사용하며, 탭은 사용하지 않는다.
  • 오직 single quote만 사용한다.
  • 템플릿 리터럴은 표현식에 사용하거나 single qoute가 문자열 내부에서 중첩될때만 사용한다.
// 예시
`mike's`

프리티어 규칙

{
  "tabWidth": 2,
  "endOfLine": "lf",
  "arrowParens": "always",
  "singleQuote": true,
  "semi": true,
  "trailingComma": "all",
  "printWidth": 80
}

Issue 형식

[title] / body
### Issue 타입(하나 이상의 Issue 타입을 선택해주세요)
-[] 기능 추가
-[] 기능 삭제
-[] 버그 수정
-[] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 상세 내용
ex) Github 소셜 로그인 기능이 필요합니다.

### 예상 소요 시간
-[] 0.5h
-[] 1h
-[] 1.5h
-[] 2h
-[] 2.5h
-[] 3h

### 라벨
- 예상 소요 시간: E: 1h
- 그룹: client, server
- 긴급도: High, Middle, Low

브랜치 이름 형식

  • main
    • 프로덕션 스냅샷
    • 가장 최신의 배포된 버전
  • dev
    • 릴리즈 계획에 따라서 Github 에서 기본 브랜치로 지정
  • feature
    • 사용패턴) feature/이슈번호-이름 || feature/1-branch-name
    • dev 에 병합
  • hotfix
    • 사용패턴) hotfix/이슈번호 || hotfix/#991
    • 메인에 병합

변수이름 camel-case

  • clientLogin

파일 & 생성자 이름 -pascal-case

  • ClientSide

node & npm 버전 통일

  • Node 16.14.0
  • npm 8.3.1