Skip to content

Team Rule

chayezo edited this page Nov 11, 2021 · 13 revisions

회의 일정

시간 내용
09:00 오늘 일정 및 이슈 공유
13:00 중간 회의
17:00 코드 리뷰
  • 중간 회의는 디스코드로 필요여부 확인 후 진행
  • 매주 월, 목요일 저녁회의는 화, 금 KPT제출을 위한 회의
  • 매주 화, 금요일 저녁은 개인 Dev-log 작성
  • 매주 수요일 저녁은 개인 Error Handling Card 작성

작업 및 휴식

  • 당일 목표를 설정합니다.
  • 목표 달성 시 개인시간을 갖습니다.
  • 목표 미달성 시 개인시간을 투자합니다.
  • 정해진 예상 시간을 1시간 이상 초과한 경우, 도움을 요청합니다.
  • 개인 작업 중 휴식시간을 갖을 시 디스코드 상태를 변경합니다.
  • 매주 금요일 주말 간 개인시간 사용여부를 결정합니다.

커밋 메시지 규칙

  • 커밋 메시지 작성 양식은 행동: #이슈번호 변경내용 입니다.

  • 커밋 메시지는 제목과 본문으로 나누어 집니다.
    한 줄만 작성해도 설명이 충분하다면 제목만으로도 괜찮습니다.
    하지만 어떤 변경 사항이 있는지 맥락과 설명이 필요하다면 본문을 작성할 수 있습니다.
    다음은 제목과 본문을 작성하는 규칙입니다.

  1. 제목과 본문을 한 줄 띄워 분리해 주세요.
  2. 제목은 영문 기준 50자 이내로 적어주세요.
  3. 첫 글자는 대문자로 작성합니다.
  4. 제목 끝에 . 는 금지합니다.
  5. 제목은 명령어로 작성합니다.
  6. 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성하세요.
태그이름 설명
Feat 새로운 기능을 추가할 경우
Fix 버그를 고친 경우
Design CSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE 커다란 API 변경의 경우
!HOTFIX 급하게 치명적인 버그를 고치는 경우
Refactor 코드 리팩토링
Comment 필요한 주석 추가 및 변경
Docs 문서를 수정한 경우
Chore 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우
Rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우
Remove 파일 혹은 폴더를 삭제하는 작업만 수행한 경우
[Client] Add: #2 landing page
[Server] !BREAKING CHANGE: #5 change API arguments

PR 형식

  • 코드 컨벤션을 잘 지켜주세요. 컨벤션 오류로 인한 불필요한 코멘트는 시간 낭비이기 때문에 지양하는 것이 좋습니다.

  • PR 제목

[브랜치 명] 수정 내용
  • PR 본문
  • 아래 형식을 복사해 Github Pull Request 의 템플릿으로 지정 후 해당 본문은 삭제하시면 됩니다.
## 작업사항
>

## 변경로직
   - ### 변경전
         -
   - ### 변경후
         -

Lint 규칙

  • semistandard를 따릅니다.
  • 오직 single quote만 사용, 템플릿 리터럴은 표현식 사용할때만 사용합니다.
  • var 키워드는 사용하지 않습니다.
  • 키워드 다음엔 스페이스 하나를 띄워 사용합니다.
  • VSCode extension 중 하나인 Prettier를 사용합니다.

.prettierrc.json

{
  "singleQuote": true,
  "semi": true,
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 100
}

브랜치 이름 형식

종류 사용패턴 특징
master master 가장 최신의 배포된 버전
dev dev 릴리즈 계획에 따라서 Github에서 기본 브랜치로 지정
feature feature이슈번호/변경내용 dev에 병합

변수 이름

  • Camel-case
  • ex) camelCase

파일, 생성자 이름

  • Pascal-case
  • ex) PascalCase

node, npm 버전 통일

  • node: 14.18.0
  • npm: 7.24.2