Team Rule

생활 규칙

• am 10:00 회의 진행, 금일 해야할 일들을 이슈카드에 작성 (회의록 번갈아가며 작성)
• pm 12:00 점심 시간 (1시간)
• pm 06:00 저녁 시간 (1시간)
• pm 09:00 금일 자세한 코드 리뷰 + (10/21, 10/25, 10/28, 11/1, 11/4, 11/8, 11/11) KPT 팀회고 및 미팅로그 작성
  • 미팅로그 작성법
• pm 10:00 금일 개인 회고록, Dev Log 작성

의사소통 규칙

• 말하다 말기 금지 (스쳐지나가는 생각도 공유합니다)
• 이슈에 대한 내용 디스커션에 기록하기
• 단톡방 답장 필수
• 지각시 30분 전에 상황 공유하기
• 2:2 의견이 나눠질 시, 담당자가 결정 권한을 갖기

컴포넌트 규칙

• 파스칼 표기법을 사용합니다. (ex. WeAreTheOne) - 앞글자 대문자 표기!
• 기본적으로 함수 컴포넌트로 제작합니다. (React Hooks 사용)

변수 & state 규칙

• 카멜 표기법을 사용합니다. (ex. weAreTheOne) - 앞글자는 소문자, 뒷음절부터는 앞글자 대문자 표기!
• 불린 값을 이용하는 경우, is를 앞에 넣습니다. (ex. isPrime)
• 변수가 배열인 경우, arr을 앞에 넣습니다.
• 변수가 obj인 경우, obj를 앞에 넣습니다.
• 변수가 number인 경우, num을 앞에 넣습니다.
• 변수가 string인 경우, str을 앞에 넣습니다.

클래스 명 규칙

• 파스칼 표기법을 사용하되 각 단어 사이에 _ 로 구분합니다. ex) Main_Btn

커밋 메세지 작성 규칙

• 커밋 제목 작성 요령

• [페이지명][기능명] 수정한 내용을 문장으로 작성합니다. ex) [MyPage][EditInfo] 사용자 정보 수정 기능 구현
  • Back-End는 위 제목 규칙은 지키지 않아도 되지만 Task Card Naming Rule과 최대한 통일성 있게 작성.
  • 페이지명 - 화면에 표시되는 페이지 컴포넌트의 이름을 작성합니다.
  • 기능명 - 페이지 내에서 작동하는 기능 컴포넌트의 이름을 작성합니다. 컴포넌트가 아닐 경우 일반적인 기능명으로 대체.
  • 한눈에 내용을 알아보기 용이한 개조식 문장을 사용합니다. ex) 합니다. 입니다. => 함. 임

• 커밋 내용 작성 요령
  • 수정하거나 추가한 파일 이름을 작성하고 수정한 내용을 기입합니다. ex) app.js → root 컴포넌트 호출
  • 다른 사람이 봤을 때 어떤 작업을 한건지 충분히 이해할 수 있도록 합니다.
  • 사소한 것을 수정했어도 기입해야 합니다. ex) 변수명 변경

PR 메시지 작성 규칙

• 앞에 [Client]/[Server] 구분 후, 커밋메시지와 동일하게 작성하되, 커밋메시지에서 미처 생각나지 않은 내용이 있으면 추가할 것.

Merge 규칙

• merge 전 꼭 전체 팀원에게 알린 후 merge 한다.
• 9시 회의 때 리뷰 후 같이 Merge 한다.
• Merge 할 시 커밋 메세지와 같게 작성
• PR 메시지와 같게 Merge 제목 및 내용 통일
  • 예시: [Client][Mypage][Favorite] 내가 찜한 게시글 구현 완료 - 제목, 내용 동일

충돌 발생 시 규칙

• fix conflict 로 커밋메시지와 PR 메시지를 작성해 merge 한다.

Prettier Rule 설정

• Tab Width : 2
• Auto-Semicolon : Yes
• Prettier 기본 설정을 따른다.

브랜치(Branch) 규칙

브랜치명 예시 : [Feature/login] [Feature/signup]

• 예외적으로 css 스타일을 입히는 Task의 경우 위와 같은 브랜치 Numbering Rule을 적용하지 않는다.
• dev branch는 늘 최신 상태로 유지한다고 생각하자.
• master branch에서는 배포 준비를 위해 console.log나 사용하지 않은 변수 등 불필요한 코드들을 모두 제거한 상태여야 한다.

npm, node 버전 통일

• node -v: 14.18.1
• npm -v: 7.24.0