재호팀 개발 방식 - prgrms-fe-devcourse/FEDC2_Shallenge_Jaeho GitHub Wiki
폴더 구조
📦src
┣ 📂api
┣ 📂assets
┣ 📂components
┃ ┣ 📂base // 여러 페이지에서 쓰이는 컴포넌트 폴더
┃ ┣ 📂domain // 특정 페이지만을 위한 컴포넌트 폴더
┃ ┣ 📂Provider
┃ ┗ 📂Router
┣ 📂hooks
┃ ┣ 📂quries
┣ 📂layout
┣ 📂lib
┣ 📂pages
┣ 📂store
┣ 📂stories
┣ 📂styles
┃ ┗ 📜GlobalStyles.tsx
┣ 📂types // 타입 정의를 위한 폴더
┃ ┗ 📜index.ts
┣ 📜App.tsx
┣ 📜index.tsx
┗ 📜react-app-env.d.ts
커밋 컨벤션
-
feat
: 새로운 기능을 추가하거나 기존의 기능을 변경한 경우feat: a 기능 추가
-
fix
: 기능상 오류를 수정했을 경우fix: a 기능 오류 수정
-
docs
: 문서 또는 주석을 추가, 수정한 경우, 직접적인 코드의 변화 없이 순수하게 문서(주석)만 추가/수정했을 경우docs: Readme 수정
,docs: a 부분 주석 추가
-
style
: UI를 추가/변경 하거나 스타일 관련 작업을 했을 경우style: a 컴포넌트 스타일 추가
-
refactor
: 기능의 변화가 아닌 코드를 리팩토링했을 경우, 이름을 변경하였거나, 코드 pretty 등을 적용했을 경우refactor: a 컴포넌트 코드 리팩토링
,refactor: b 컴포넌트에서 사용되는 변수 이름 변경
-
chore
: 기능/테스트 코드, 문서, 스타일, 리팩토링을 제외한, 배포, 빌드 등과 같이 프로젝트의 기타 작업들에 대해 추가/수정했을 경우, lint 등의 적용으로 코드 스타일을 수정 했을 때도 chore 사용chore: a 패키지 설치
,chore: pakage.json a부분 수정
PR 컨벤션
브랜치 prefix에 따라서 pr 작성
[prefix] 작업에 대한 설명
[feature] a 컴포넌트 개발
[fix] a 컴포넌트 오류 수정
[refactor] a 컴포넌트 리팩토링
Issue 컨벤션
-
Github Projects(classic)을 이용하여
To do
,In progress
,Done
에 따라 작업을 진행To do
: 할 일을 생성In progress
:To do
에 있던 태스크를 옮겨 Issue로 바꾸고 작업자에게 할당Done
: 작업이 끝나고 PR이 정상적으로 merge 되었을 경우 Issue를 close 한 후 이동
-
본 작업 기간 동안은 제목과 내용을 간결하게 작성했고, 리팩토링 기간에는 [n주차] "이슈 제목"을 사용