Team Rule

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

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

예시

Feat: Add get data api function
!BREAKING CHANGE: change API arguments

1. 사용할 단어의 목록
   • ADD(기능의 추가)
   • FIX(애러 수정)
   • MERGE(병합)
   • REMOVE(삭제)
   • UPDATE(문서 파일을 수정)
   • REFACTOR(코드의 수정을 통한 리펙토링)
   • SIMPLIFY(코드 단순화)
   • IMPROVE(기능의 향상)
   • UPDATE(최신화)
   • MOVE(코드의 이동)
   • RENAME(이름의 변경)
   • VERIFY(검증)
2. 동사 : 이후 짧게 내용을 적는다.
3. 필요한 경우를 제외하고는 동명사 대신 명사를 사용한다.
4. 필요한 경우를 제외하고 관사는 사용하지 않는다.
5. 부정문을 사용할때는 Don't 를 사용한다.
6. 전치사를 주로 사용하여 정확하게 어떤 부분을 수정한 것인지 명시한다.

❗ 이것은 꼭 지킵시다!

• PR 전 이유없는주석이나 console 등 지우자!
• PR 시 양식 통일 하자!
• img, btn, idx 등 변수명 줄여쓰지 말자!
• 함수 명은 무조건 동사로 통일하자!
• Boolean 값은 is(ex. isLogin)명사로 통일하자!
• 배포 주기는 feature 하나 합칠 때마다 다같이 하자!
• 논의되지 않은 새로운 스택 사용 하지말자!
• 혼자서 MERGE,PR 금지! 필요할 시 상의후 PR 하자!

💅 Front-end

• 스크롤바 항상보기 표시하자 !
• 반응형 디자인 신경쓰자 (ex. 미디어 쿼리) !
• 컴포넌트 이름 PascalCase로 통일 하자! (ex. WebDesign )
• 이미 디자인 가이드가 만들어져있는 CSS 프레임워크를 사용하지 말자! (ex. Material UI, Ant design, bootstrap)
• UX상 나쁜 디자인으로 평가받는 브라우저 내장 기능의 지나친 사용하지 말자!(ex. `alert, prompt, confirm)
• 콘텐츠가 존재하나 스크롤 할 수 없는 영역이 존재 하면 안된다!
• "스크롤바 항상보기" 옵션을 사용시, 불필요하게 스크롤바가 보임 그러므로 사용하지 말자!
• 데이터가 없거나 에러가 있을경우 안내가 나와서 명시적으로 보이게끔 하자!
• 로딩 실패 시 적절한 피드백을 제공 하자!
• 로딩 시 레이아웃이 깨짐 현상이 없게 로딩처리를 하자!
• 개발자 콘솔을 열었을 때 자바스크립트 에러가 발생하지 않게 하자!
• 로그인을 하지 않을 경우 일부 기능에 제한을 두게 만들자!

📚 Back-end

• 에러 메시지는 무조건 한글로 적자!
• 파라미터에 민감한 정보가 노출되지 않게 하자!
• EndPoint, DataBase Table 모두 단수 형식으로 통일 하자! (ex. number , list)
• 소셜 로그인 구현시 passport.js 사용을 하지 말자!

📂 API

• 리소스 CRUD시 목적에 맞는 HTTP 메소드를 사용하자!
• 리소스 CRUD시 엔드포인트에 동사를 사용하지 말자!
• 리소스 요청/응답시 필요한 json의 키/값 타입을 명시하자!
• 리소스 여러 개 조회 시 배열을 사용하자!
• HTTP 응답 코드의 사용이 적절하게 표시되게 하자!
• 응답 에러 메시지의 일관성이 있게 작성하자!
• 리소스 조회 시 json과 스키마 field간의 일관성이 있게 만들자!
• 리소스 생성 시 신규 아이디를 리턴하자!
• 사용자 정보를 필요로 하는 요청에 토큰 또는 세션을 사용해서 만들자!
• 특정 사용자와 연관된 리소스 조회시 권한 문제를 고려해서 만들자!
• JWT 사용시 헤더에 토큰을 전달하는 내용을 명시해서 만들자!
• 엔드포인트가 spinal-case (소문자와 대시 문자열) 를 따르게끔 만들자!
• GET 요청에서 쿼리 파라미터 대신 HTTP body를 사용하지 않고 만들자!
• HTTP body를 사용해야 하는 상황에서 쿼리 파라미터를 사용하지않고 만들자!

🔍 Schema

• 스키마의 1:N, N:M 관계가 적절하게 만들자!
• Join Table의 이름이, 관계있는 테이블 이름을 포함하게 만들자!
• 리소스의 CRUD에 필요한 테이블이 존재하도록 해서 만들자!

TASK CARD 예시

<TASK CARD 예시>

ISSUE Group: client, server, sr Type: bug, feature, delete

TODO -[ ] Job1 -[ ] Job2 -[ ] Job3

Estimated time Pick one

0.5h 1h 1.5h 2h 2.5h 3h

Labels Estimated time: E: 1h Group : client, server Sprint: Sprint__NUMBER__ Urgency: High, Middle, Low

npm & node version 통일

npm 8.1.0 node 16.13.0