Code Convention

Code Convention

Code Style Guide

• const를 기본으로 사용하고, 재할당이 필요한 경우에만 let을 사용합니다.
• 주석은 대상의 위에 간략하게 작성합니다.
• img 태그의 alt는 필수적으로 작성합니다.
• 약어 사용을 지양하고 명확한 이름을 사용합니다. (ex. submitButton)
• 컴포넌트는 함수 선언식으로, 나머지 함수는 함수 표현식을 사용합니다.
• 문자열은 쌍따옴표를 사용하며, 문장 끝에는 세미콜론을 붙입니다.
• 타입 선언은 interface로 통일합니다.

Naming Guide

• 폴더명: kebab-case 사용 (ex. component-folder).
• 파일명: 컴포넌트는 PascalCase (ex. MyComponent.jsx), 그 외는 camelCase (ex. useCustomHook.js).
• 변수명 및 속성명: camelCase 사용(ex. userName).
• 상수: 대문자와 snake_case (ex. NAME_ROLE).
• 함수 이름: 동사+명사 구조 사용 (ex. getUserData).
• Boolean 변수: is 또는 has 접두사 사용 (ex. isCustomer, hasProduct).
• 배열 이름: 복수형으로 명명 (ex. userList).

Accessibility Guide

• ARIA Attributes: 필요한 경우에만 사용하며 컴포넌트의 목적을 명확히 설명합니다.
• Semantic HTML Tags: <header>, <footer>, <main>, <section> 등 시맨틱 태그를 사용해 구조를 명확히 표현합니다.

Pn/Dn Rules

Pn Rule (리뷰 코멘트 중요도 표시)

사용 목적: 리뷰 코멘트의 중요도를 Pn 태그로 표시하여 피드백의 우선순위를 명확히 전달합니다.

• P1: 반드시 반영해야 하는 사항 (ex: 보안 문제, 명백한 버그)
• P2: 적극적으로 고려해야 하는 사항 (ex: 기능적으로 개선이 필요한 부분)
• P3: 웬만하면 반영하는 것이 좋은 사항 (ex: 가독성을 높이는 리팩토링)
• P4: 반영해도 좋고 넘어가도 좋은 사항 (ex: 스타일 관련 개인적인 의견)
• P5: 사소한 의견 (ex: 미미한 코드 스타일 변경)
  Pn 룰을 사용하면 리뷰어는 피드백의 중요도를 명확히 전달할 수 있고, 리뷰 요청자는 수정의 우선순위를 쉽게 판단할 수 있습니다.

Dn Rule (리뷰 요청 긴급도 표시)

사용 목적: PR이 머지되어야 하는 일정을 D-n 태그로 표시하여, 리뷰어가 우선순위를 판단할 수 있도록 합니다.

• D-0 (ASAP): 긴급한 수정사항으로 즉시 리뷰가 필요합니다. (ex: 배포 전 발견된 중요한 이슈)
• D-N (Within N days): N일 이내에 리뷰가 필요합니다. 일반적으로 D-2 태그를 많이 사용합니다. (ex: 스프린트 내에 반드시 포함되어야 하는 기능)
• D-5: 여유로운 일정 내에 처리 가능한 PR.

Dn 룰을 통해 리뷰어는 자신의 업무 일정에 맞춰 리뷰 우선순위를 효율적으로 조정할 수 있습니다.

Pn/Dn 규칙은 코드 리뷰의 효율성을 높이고, 커뮤니케이션 비용을 줄이는 데 기여합니다.