Skip to content

Team Rule

3002 edited this page Oct 19, 2021 · 8 revisions

팀 규칙

  1. , , 17시 팀원들과 KPT 회고 후, , KPT 공유합니다.
  2. DevLog는 자율적으로 작성하시면 됩니다.
  3. 오전 9시부터 30분간 건강 및 특이사항 확인후 일과 진행합니다.
  4. 휴식은 원할때 편히 쉬시면 됩니다.
  5. 평일 9to6까지 팀 Gather town에 필히 접속하여 원활한 의사소통이 될 수 있도록 합니다.
  6. Commit 작업 단위는 아래와 같습니다.
    • 컴포넌트 단위
    • 함수, 기능 하나 단위
  7. Merge하기 전 충돌이 발생했을때 PR 요청한 사람이 해당 부분을 작업한 팀원과 상의 후 충돌을 해결합니다.

의사소통 규칙

  1. 서로 의견이 맞지 않을 때, 과반수로 정하기보다 사다리 타기나 제비뽑기와 같은 방법으로 해결합니다.
  2. 건강 상태가 좋지 않거나 병원 또는 개인적인 사유가 있을 시 해당 사항을 팀원과 공유합니다.
시간 비고
09:00 ~ 09:30 하루 계획, 건강 및 특이사항 확인
09:30 ~ 12:00 오전 작업
12:00 ~ 13:00 점심 식사
13:00 ~ 13:30 중간 점검
13:30 ~ 17:00 오후 작업
17:00 ~ 18:00 코드 리뷰 및 회고, PR 또는 머지
18:00 ~ 자율적으로
  • 휴식은 자율적으로 합니다.

코드 스타일

Prettier

.prettierrc

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

커밋 메시지 규칙

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

  1. 제목과 본문을 한 줄 띄워 분리해 주세요.
  2. 제목은 영문 기준 50자 이내로 적어주세요.
  3. 제목 끝에 . 는 금지합니다.
  4. 제목은 명령어로 작성합니다.
  5. 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성하세요.

Type 종류

태그이름 설명
feat 기능을 추가한 경우
fix 버그를 수정한 경우
modify 기능을 변경한 경우
chore 그 외 자잘한 수정을 한 경우
move 파일 이동한 경우
refactor 전체적으로 수정한 경우
test 테스트 관련 코드를 작업한 경우
build 빌드 관련 파일 수정한 경우
remove 코드를 지웠을 때
rename 파일이름을 변경했을 때

예시

[Client/Server] Type: 작업한 내용

[Client] feat: 댓글 기능 추가
[Server] modify: Users 모델 생성

브랜치 이름 형식

종류 사용패턴 특징
master master 가장 최신의 배포 버전
dev dev Github 기본 브랜치로 지정
feature feature1 dev에 병합
hotfix gotfix1 메인에 병합

PR 형식

  1. 코드 컨벤션을 잘 지켜주세요. 회의를 통해 정한 코드 작성시 Lint 규칙과 코드 컨벤션을 잘 지켜주세요.
  2. 리뷰 가이드라인을 잘 작성해 주세요. 모든 코드 변경사항에는 의도가 필요합니다. 의도치 않게 변경된 부분이 있다면 되돌려 놓아야 하고, 줄바꿈과 같이 아주 단순한 변경사항이라도 그 부분을 리뷰어가 볼 필요가 없다면 필요한 코멘트를 한글로 달아 명시하여 리뷰 시간을 줄여줄 수 있을 것입니다.
  3. 작업중, 리뷰 가능 여부를 잘 명시해 주세요. 프로젝트 커뮤니케이션 공간에 PR 가이드를 참고하여 칸반보드에 태스크 카드 이동시 서로 공유하며 작업해주세요.
  4. PR 제목 관련. PR 제목과 부연 설명은 커밋메세지와 같이 한글로 작성하여 주세요.

PR 제목 예시

[프론트엔드] 기능 구현 : 상세 내용 [백엔드] 버그 수정 : 상세 내용

PR 본문

PR 타입(하나 이상의 PR 타입을 선택해주세요)

  • 기능 추가
  • 기능 삭제
  • 버그 수정
  • 의존성, 환경 변수, 빌드 관련 코드 업데이트

반영 브랜치

  • feat/login -> dev

변경 사항

  • 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

테스트 결과

  • 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

네이밍 규칙

  • 변수 이름 : camelCase
  • 컴포넌트 파일 이름 : PascalCase
  • 그 외 : camelCase

node & npm 버전 통일

  • Node : v14.17.*
  • NPM : v7.24.*