Team Rule

목차

• 팀 커뮤니케이션 룰
• 커밋 메세지 규칙
• Lint 규칙
• 브랜치 이름 형식
• PR 형식
• Issue 형식

팀 커뮤니케이션 룰

1. 신데렐라 규칙 : 특이사항이 없는 이상 자정 이후엔 게더에 모이지 않도록 한다.
2. 코드 리뷰(merge) 타임을 특별히 가지지는 않되, merge를 할 때 되도록이면 코드 진행 상황 파악을 위해 팀원 모두가 같이 한다.
   단, 프로젝트에 전체적인 흐름을 건드리지 않는 내용의 PR요청은 프론트와 백엔드 각각 진행한다. 
   merge는 최우선 사항으로 삼아서 앵간하면 머지를 하도록 한다.
3. 점심시간 12시 ~1시 저녁시간은 6시부터 7시. 7시에서 8시까진 개인 정비 시간.
4. 질문 잘 받아주기. 모른다는 말을 무서워하지 않고 궁금하면 있으면 궁금한 점을 명확히 하여 물어보기.
5. 모닝콜 시스템. 9시에 안 오시면 팀원이 디스코드 전화하기.
6. 특이 사항 없이는 아침 10시 이후론 카메라를 끄는 행위 금지
7. 주말은 1시 회의, 이후 일요일까지 자유 행동.(단 월요일에 숙제 지참해서 와야함) 
8. 팀적인 콜이 들어오면 합당한 이유가 없는 한 콜을 최우선한다. 개인 코드 작성은 합당한 이유에 속하지 않는다.
9. 팀회의는 누구나 언제든 호출할 수 있다. 주말 제외.

커밋 메세지 규칙

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

1. 제목과 본문을 한 줄 띄워 분리해 주세요.
2. 제목은 영문 기준 50자 이내의 소문자로 적어주세요.
3. 제목에 변경 사항이 "무엇"인지 명확히 작성해 주세요.
4. 제목 끝에 . 는 금지합니다. 
5. 제목은 명령어로 작성합니다.
6. 본문은 3줄 이내, 한 줄은 50자 이내로 작성해 주세요. 여러 줄의 메시지를 작성할 때는, 맨 앞에 "-"를 붙혀주세요.
7. 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성하세요.
8. 꼬릿말(footer)이 필요한 경우, 가장 아랫줄에 작성해 주세요.(현재 커밋과 관련된 이슈 번호 추가 등)

• 예시

---

#제목 예시
feat: add get data api function

#본문 예시
- a 버튼의 링크가 잘못 걸려 있어서 수정

#꼬릿말 예시
resolves #7

Lint 규칙

• semistandard 를 따릅니다.
• eslint-config-standardard 모듈을 사용한 semistandard

브랜치 이름 형식

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

PR 형식

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

• 리뷰 가이드라인을 잘 작성해 주세요.
  모든 코드 변경사항에는 의도가 필요합니다.
  의도치 않게 변경된 부분이 있다면 되돌려 놓아야 하고, 줄바꿈과 같이 아주 단순한 변경사항이라도
  그 부분을 리뷰어가 볼 필요가 없다면 “Just line change” 와 같은 코멘트를 달아 명시하면 리뷰 시간을 줄여줄 수 있습니다.
  또는 사용된 라이브러리 업데이트가 포함되었다면 해당 라이브러리의 릴리즈 노트 링크나 스크린샷을 첨부하는 것도 좋은 방법입니다.

• 작업중, 리뷰 가능 여부를 잘 명시해 주세요.
  아직 코드를 작성 중일 때에는 [WiP] (Work in Progress) 를 타이틀 앞에 추가하고,
  만약 작업이 끝났으면 이를 제거하고 review-needed 태그를 설정할 수 있습니다.
  한 번 작업을 마쳤다고 끝난 것이 아니기 때문에 리뷰를 반영하는 중에도 이 과정을 반복하여 명시해 주세요.

• PR 제목

---

  [Client] / #88 / edit: readme

• PR 본문

---

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

### 반영 브랜치
ex) feat/login -> dev

### 변경 사항
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

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

Issue 형식

• Issue 제목

---

[title] / body

• Issue 본문

---

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

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

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

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

변수 이름 - Camel-case

• clientLogin

파일, 폴더 & 생성자 이름 - pascal-case

• ClientSide

node & npm 버전 통일

• Node v16.10.0

• NPM v7.24.0