02. 프로젝트 컨벤션 및 환경설정

프로젝트 컨벤션은 아래의 규칙을 지키기 위해 노력했습니다.

Branch prefix

• feature : 새로운 기능
• fix : 버그 수정
• hotfix : 배포된 상태에서 빠르게 버그 수정
• design : 스타일만 수정(중요도 낮은)
• docs : README 작성 등 문서 관련

Commit prefix

• feat : 기능 추가
• fix : 버그 수정
• refactor : 코드 리팩토링
• chore : 라이브러리 등 환경 추가 및 수정
• design : 스타일(css) 추가 및 수정

husky, lint-staged

• husky를 이용해 commit 전에 코드 컨벤션을 확인합니다. lint-staged를 트리거 합니다.
• lint-staged를 이용해 eslint, prettier cli를 실행합니다. 이는 Git의 staging area에 들어가 있는 코드를 대상으로 합니다.

ESLint

• eslint:recommended
• next/core-web-vitals
• plugin:@typescript-eslint/recommeded
• eslint-config-prettier

위 확장을 사용합니다.

또한 eslint-plugin-import를 사용해 import 구문을 규칙에 맞게 정렬합니다. import 구문의 정렬 및 규칙은 'ESLint로 import 구문에 규칙 넣기'에 자세히 설명해두었습니다.

GitHub 템플릿 사용

PR message에 명시해야 하는 정보를 템플릿화 하여 사용합니다. .github/PULL_REQUEST_TEMPLATE.md 파일을 생성하고, 아래 내용을 넣어두면 PR 생성 시 자동으로 message 템플릿이 생성됩니다.

## 주제

- PR 주제에 대한 간략한 설명을 적는다.

## 작업 내용

- 어떤 작업을 했는지 작성한다.

## ⭐️ 멘토님 코멘트 필요

- 검토가 필요한 내용을 적는다.