Skip to content

Code Convention

an seungji edited this page Oct 18, 2024 · 3 revisions

Code Convention

Code Style Guide

  • 변수 선언 시 const를 기본값으로 합니다, let은 재할당이 필요한 경우에만 사용합니다.
  • 주석은 설명하고자 하는 대상의 위에 쓰되, 간략하게 작성합니다.
  • img 태그에 alt를 한글로 필수적으로 작성합니다.
  • 최대한 약어 사용을 지양하고 명시적으로 작성합니다. (ex. submitBtn(X), submitButton(O))
  • 함수 선언 시 표현식으로 사용하며, callBack 함수의 경우에는 화살표 함수를 사용합니다.
  • 컴포넌트는 export default로, 다른 요소는 export로 내보냅니다.

Naming Guide

  • Component 파일명은 kebab case를 사용합니다. (ex. kebab-case-naming-convention.jsx)
  • Non-Component 파일명은 camelCase를 사용합니다. (ex. cookieHelper.js, fetchApi.js)
  • 속성명은 camelCase를 사용합니다. (ex. className, onClick)
  • 변수명은 camelCase를 사용합니다.
  • 상수의 경우, 영문 대문자와 snake_case를 사용합니다. (ex. const NAME_ROLE)
  • 이름을 통해 쓰임새를 알 수 있도록 합니다. (20자 미만, 직관적이게)
  • 함수 이름은 동사+명사 구조로 네이밍합니다.
  • boolean 타입의 경우, is 또는 has 접두사를 사용합니다. (ex. isCustomer, hasProduct)

Project Overview

Ground Rule

Template

Agile Process

Daily Scrum

1주차 작업 내용
2주차 작업 내용
3주차 작업 내용
4주차 작업 내용
5주차 작업 내용
6주차 작업 내용
7주차 작업 내용
8주차 작업 내용

Weekly Sprint

주차별 스프린트 회고 내용
연장 스프린트 회고 내용

Clone this wiki locally