Code Rule

Rule

• 코드만으로 이해할 수 있는 코드를 작성합니다.
• 레포의 .prettierc를 항상 적용합니다.
• camelCase 를 기본으로 사용합니다.
• 한 파일의 코드 길이는 n line 으로 제한합니다.
• 아래 내용은 모두 협의가 필요합니다. (일요일 회의에서 fix)
  • 규칙 정확하게 잡고, 그 이후에 refactoring 할 수 있도록 함.

Interface & Type

• Type의 경우 Object 형태가 아닌 interface를 받아와 사용합니다.
• Response 의 규격의 경우 다음과 같이 정의합니다.
  • QueryNameRes
• 만약, DB Entity 의 결과물을 받아오는 경우에는 되도록 해당 Entity의 Interface를 사용합니다.
  • User, Reservation, MentorProfile ...
  • 위와 같이 함께 사용하는 Entity의 경우 반드시 타입을 정의하고 사용합니다.
• Request 형식은 다음과 같이 정의합니다.
  • QueryNameReq

Variables

• 해당 변수의 의미를 명확하게 의미해야합니다.

Functinons

• doSomething 의 형태를 취합니다. (동사가 앞에 와야함)
• 특정한 유틸리티 기능을 담당할 경우 /utils 에 별도로 구성합니다.

Components

• component 는 PascalCase를 사용합니다. (ex: ReservationCard)

Pages

• page 는 PascalCase를 사용합니다. (ex: /Mentoring)

Styles

• css의 경우 class-name-example 과 같은 포맷을 사용합니다.
• 내부 디자인과 관련된 요소의 경우 tailwind css를 이용하여 /styles 에 구성합니다. (공통된 요소로 분리)
  • 예시 : 전체적으로 형태가 일치해야하는 버튼의 경우 별도의 css 구성 (btn)
• 외부 디자인 시스템의 경우 antd를 사용하며, 디자인 시스템의 컴포넌트가 호환이 되지 않는 경우 tailwind css 를 통해 작성합니다.