- 커밋 유형은 영어 소문자로 작성하기
| 커밋 유형 | 의미 |
|---|---|
| feat | 새로운 기능 추가 |
| style | 스타일 코드 변경 |
| type | 타입 수정 |
| fix | 버그 수정 |
| docs | 문서 수정 |
| refactor | 코드 리팩토링 |
| test | 테스트 코드, 리팩토링 테스트 코드 추가 |
| chore | 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore |
| rename | 파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우 |
| remove | 파일 삭제하는 경우 |
| hotfix | 급하게 치명적인 버그를 고쳐야 하는 경우 |
- 한글로 무엇을 했는지 작성
- 요약 느낌
- 더 구체적인 것은 Pull Request에서 작성
- 파일 A, 파일 B, 파일 C, 파일 D에 대해 작업
- ABCD → 한번에 커밋 한개로 날리는 경우 (x)
- 기능 별로 나눠서 파일을 묶어서 커밋
- ex) 게시글 생성 → 파일 A와 파일 C → A랑 C를 하나의 커밋
- ex) 게시글 삭제 → 파일 B와 파일 D → B랑 D를 하나의 커밋
📁 폴더명의 경우 소문자 작성
📄 컴포넌트 파일명은 PascalCase로 통일 📄 그 외 파일명은 소문자 작성
ex) Home.tsx ex) index.d.ts
➰ 함수명, 변수명은 camelCase로 작성
- 이름을 통해 어떤 기능을 제공하는지 알 수 있도록 작성
- 딕셔너리, 배열 등의 복수의 데이터를 담는 자료구조에 대한 변수명 s 붙이기
ex) heights - 로딩이나 모달창 등의 보여짐 여부에 대한 boolean state의 경우 is 붙이기
ex) isModalOpen, isLoading - 데이터 접근 함수의 경우 get으로 시작하기
ex) getUserData
| 함수명 | 동사구 ex) getUserData |
|---|---|
| 변수명 | 명사구 ex) userData |
1️⃣ 인라인 주석
- 무분별하게 line by line 주석은 지양
- if문, for문, switch문 그런 구문 선언 부분 위에 간단하게 어떤 기능을 하는지 설명
- 설명에 대한 주석은 한글로 작성
2️⃣ 함수 주석
/**
* 함수 설명
* @param a: 덧셈을 위한 첫번째 인자
* @param b: 덧셈을 위한 두번째 인자
* @return: 인자로 받은 두 정수를 더한 값을 리턴
*/
const filterDescription = (a, b) => {return {a, b}};3️⃣ TODO Highlight
- 진행해야 될 부분 메모