👨‍💻 Code

1. 기본적으로 네이밍은 누구나 알 수 있는 쉬운 단어를 선택한다.

2. 변수는 CamelCase를 기본으로 한다.

   • userEmail, userCellPhone ...

3. URL, 파일명 등은 kebab-case를 사용한다

   • /user-email-page ...

4. 패키지명은 단어가 달라지더라도 무조건 소문자를 사용한다. 단어별 구분을 위해 언더스코어 '_' 나 대문자를 섞지 않는다.

   • repository, useremail ..

5. ENUM이나 상수는 대문자로 네이밍한다.

   • NORMAL_STATUS ...

6. 컴포넌트 명은 명사로 작성하고 PascalCase를 사용한다.

   • UserEmail, Address ...

7. 함수명은 소문자로 시작하고 동사로 네이밍한다.

   • getUserId(), isNormal() ...

8. 이중적인 의미를 가지는 단어는 지양한다.

   • event, design ..

9. 객체 이름을 함수 이름에 중복해서 넣지 않는다.

   • line.getLength() (O) / line.getLineLength() (X)

10. 의도가 드러난다면 되도록 짧은 이름을 선택한다.

    • retreiveUser() (X) / getUser() (O)

11. 타입 정의 시 Interface를 기본으로 사용하고, 필요에 따라 Type을 고려한다.

    • Interface는 객체의 형태를 정의할 때 기본으로 사용한다.
    • 유니언 타입, 튜플 등 복잡한 타입 정의가 필요할 때는 Type을 사용한다.

12. Interface 명명은 UpperCamelCase를 사용하고, 직관적인 이름을 사용한다.

    interface User {
      id: number;
      name: string;
      email: string;
    }
    

13. Type명명은 UpperCamelCase를 사용하고, 의미가 명확한 이름을 사용한다.

👨‍💻 Github Flow

1. main 브랜치가 항상 배포 가능한 상태를 유지합니다.
2. 새로운 작업을 시작할 때는 main 브랜치에서 새로운 브랜치를 생성합니다.
3. 생성된 브랜치에서 작업을 진행하고, 정기적으로 commit합니다.
4. 작업이 완료되면, main 브랜치로 Pull Request를 생성합니다.
5. 오후 1시 30분에 PR을 리뷰하며 수정 사항이 있을 시 수정하고 병합합니다.