Rule

git flow

• main: 개발 완료 후, 마지막에 사용할 브랜치
• develop: 개발 중 사용할 브랜치(프로젝트 기간 중 이 곳에 merge 해 주세요)
• feature: 각 기능 개발 시 사용할 브랜치
• bugfix: 버그 수정 시 사용할 브랜치
• style: 스타일 관련 변경사항이 있을 경우 사용할 브랜치
• help: 도움이 필요할 경우 사용할 브랜치
• test: 테스트 코드 추가 시 사용할 브랜치

PR규칙

• PR을 올린 자신 이외에 2명의 승인이 있어야 merge할 수 있습니다
• 승인을 한 사람이 머지와 브랜치 삭제까지 함께 진행합니다

commit 규칙

• 커밋은 다음과 같은 형태로 작성합니다

keyword: 설명

• 예시

git commit -m "feature: 다크모드 라이트모드 기능 개발"

keyword 예시

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• settings: 프로젝트 세팅 관련
• style: 코드 formatting, 세미콜론 누락 등 코드 자체의 변경이 없는 경우
• refactor: 코드 리팩토링
• test: 테스트 코드, 리팩토링 테스트 코드 추가
• chore: 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
• design: CSS 등 사용자 UI 디자인 변경
• comment: 필요한 주석 추가 및 변경
• rename: 파일 또는 폴더 명을 수정하거나 옮기는 작업만 한 경우
• remove: 파일을 삭제하는 작업만 한 경우
• !BREAKING CHANGE: 커다란 API 변경사항이 있는 경우
• !HOTFIX: 치명적인 버그를 급하게 고쳐야 하는 경우

기타

• 컴포넌트 이름: PascalCase 사용
• 폴더 이름: 소문자 사용
• 이벤트 핸들러: 'on'으로 시작
• 함수 및 변수명: camelCase 사용
• 상수: 모두 대문자로 작성하고 단어 사이에 _ 사용 ex) API_URL
• 커스컴 훅(Custom Hook): use로 시작 ex) useInput