Coding_Convention

1. ESLint & Prettier를 공유하여 사용하며, 각가 FE/BE 루트 디렉토리에 위치합니다.

2. 파일명

• FE 디렉토리 내 파일
  • 컴포넌트 파일들은 파스칼 표기법 ex) PaymentMethod.js
  • 그 외 파일들은 카멜 표기법 ex) index.js
• BE 디렉토리 내 파일
  • .으로 단어를 구분합니다. ex) label.route.js
  • (예외) newLabel.route.js

3. 클래스 이름은 파스칼 표기법을 사용합니다. ex) ClassName

4. 변수 이름은 카멜 표기법을 사용합니다. ex) variableName

5. 변수의 이름은 조금 길더라도 의미를 알 수 있게 지정합니다.

6. 함수는 길지 않게 작성하며 깊이가 2가 넘지 않도록 신경씁니다.

7. 함수는 화살표 함수 방식으로 작성합니다.

8. Import 방식

• FE: default export = ... / import ... from ...
• BE: module.exports = ... / require(...)

9. 만약 주석이 필요한 경우

• // TODO: 해야 할 일 혹은 한 일을 적어줍니다.(2020.10.30)

10. DB & BE 파일명 동기화

[ DB ]
사용자테이블 -> user
이슈테이블 -> issue

[ BE ]
models/user.model.js
models/issue.model.js

11. 매직넘버 사용을 지양합니다.

12. .env 파일 내 변수들을 바로 가져다쓰지말고, 한 번 전처리해서 사용합니다.

const API_URL = process.env.API_URL;