파일의 줄 끝 문자 처리

• CRLF와 LF를 통일시키기 위해 config 설정을 다음과 같이 진행합니다.

window 사용자
git config core.autocrlf true
mac 사용자
git config core.autocrlf input

커밋 컨벤션 가이드

• 커밋 제목의 양식은 다음과 같습니다.
• 깃모지 사이트

[깃모지] [커밋타입] : 제목

example
:wrench: chore : tailwind.config 커스텀 key frames 추가

위처럼 입력할 시, Github에서 실제로 보이는 커밋은 다음과 같이 보인다.
🔧 chore : tailwind.config 커스텀 key frames 추가

네이밍 규칙

• 상수는 SCREAMING_SNAKE_CASE 로 작성합니다.
• 변수 명은 동사를 넣지 않고, 전치사를 최대한 생략합니다.
  • 또한, 불린 타입의 변수는 is, has, can 등의 접두사를 사용합니다.
• 함수 명의 첫 시작은 동사로 시작합니다.
• 그 외 이름은 관례적으로 사용하는 컨벤션을 따릅니다.
• 컴포넌트는 함수 선언문, 그 외의 함수는 화살표 함수로 구현합니다.

//상수
const MATH_PI = {'default' : 3.14};

//변수 명
const peopleList = ['Kim','Lee'];
const isValid = true;

//함수 명
const changeText = () => {};

//관례적 컨벤션
<Item clickItemCard={onClick}/> //no
<Item onClick={onClick}/> //yes

//컴포넌트
export default function MyComponet(){
	...
}

//이벤트 핸들러 등...
const onChange = () => {
	...
}

주석 관련

• 다음과 같은 상황에선 VSCode 확장 중 Highlight 를 설치하여 활용합니다.
  • 활용방법은 다음과 같습니다.
  • TODO : 앞으로 해야 할 작업이나 추가해야 할 기능을 주석으로 남겨야 할 때
  • FIXME : 현재 코드에 문제가 있거나 버그가 있는 부분을 주석으로 남겨야 할 때

• Props의 타입과 return의 타입은 타입스크립트로 추론 가능하기에 JSDoc에서 활용하지 않아도 됩니다.
  • 함수가 복잡할 경우 함수에 대한 설명은 추가해도 됩니다.
• 비즈니스 로직 혹은 지나친 추상화 된 코드가 아니면 주석은 지양합니다.
  • state의 경우 : 이름으로 추론이 가능하기에 지양합니다. 추론이 힘든 이름이면 주석을 달기 보단, 상태의 이름을 수정합니다.
  • 커스텀 훅 or 함수의 경우 : 이름만 봤을 때 어떤 기능인지 추론이 가능하므로 주석을 지양합니다. 마찬가지로 추론이 힘든 이름이면 주석을 달기 보단, 커스텀 훅 or 함수의 이름을 수정합니다.

PR 관련