Convention

🤗 Naming

파일명

• 파일명은 기본적으로 PascalCase로 작성한다.
• 컴포넌트 파일명과 style 파일명은 같다.

예시: MainPage.js, MainPage.module.scss

변수명

• 변수명은 기본적으로 camelCase를 사용한다.
• 가능한 명사를 사용한다.
• 복수의 경우 복수형 명사를 사용한다.
• boolean 형을 갖는 변수는 앞에 is를 붙인다.

함수명

• 함수명은 기본적으로 camelCase를 사용한다.
• 가능한 동사를 사용한다.
• 함수명을 축약하지 않는다.
• boolean형을 return하는 함수는 앞에 check를 붙인다.

스타일

• 스타일 사이의 구분자는 -를 사용한다.

🙄 Issue Conventions

• Issue 내용은 Todo-List 형식으로 작성한다.

👊 Commit Message Conventions

• 커밋 시 아래 규칙을 참고해 메세지를 작성하자, 영어로 작성할 필요는 없다.

• issue-number는 Github의 issue를 발급하고, 생성된 번호를 사용한다.

[#{issue-number}] feat - (feature)
[#{issue-number}] fix - (bug fix)
[#{issue-number}] refactor - (split package)
[#{issue-number}] docs - (documentation)
[#{issue-number}] style - (formatting, missing semi colons, …)
[#{issue-number}] test - (when adding missing tests)

😾 Github branching

• master
• dev
• feature/{issue-number}-{desc..}
• branch는 camelCase로 작성한다.
• Pull Request는 Merge 전 Reviewer의 approve가 필요하다.
• feature -> dev -> master

👶 Code

• VS Code의 eslint와 prettier extention을 활용한다.
• 버그가 있으면 커밋할 수 없다.
• 한 메서드에 오직 한 단계의 들여쓰기를 하기위해 노력한다.
• else 예약어는 금지한다.
• 상수는 별도의 파일로 분리해서 작성한다.