개발 방식

🔀 깃 브랜치

• dev (default)

• fe 또는 be (분야)

• 파트/#이슈넘버-기능 (기능단위 브랜치)

• 브랜치명

dev-fe#이슈번호/이슈이름 

• 브랜치 생성 방식

git checkout -b dev-fe#1/document 

🧩 깃 커밋 컨벤션

• 커밋 유형: 구현 내용
• 유형: 영어 대문자로 작성 ex FEAT
• 제목: 한글로 작성 ex 회원가입 기능 추가
• 본문: 본문에는 변경한 내용과 이유 설명하고, 여러가지 변경 항목이 있다면 글머리 기호로 가독성 높이기
• 제목과 본문은 빈행으로 분리하여 가독성 높이기
• 커밋 작성 예시

git commit -m"FEAT: 회원가입 기능 추가"

git commit -m "🎉 Document : FE 개발  환경 세팅

- CRA를 통한 개발환경 세팅
- CSS 기본 값 리셋
- EsLint / Prettier 설정
- 불필요한 파일, 코드 삭제
- 기본 디렉토리 구조 설정
- Styled-component 설치 

Issue : #1"

커밋 유형	의미
Feat	새로운 기능 추가
Fix	버그 수정
Docs	문서 수정
Modify	코드 수정
Style	코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
Refactor	코드 리팩토링
Test	테스트 코드, 리팩토링 테스트 코드 추가
Chore	패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
Design	CSS 등 사용자 UI 디자인 변경
Comment	필요한 주석 추가 및 변경
Rename	파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우

🪧PR, 이슈 컨벤션

• PR Merge 승인 방식 : Auto Assign Action을 이용한 2명에게 랜덤으로 리뷰어 할당 해당 리뷰어가 코드 리뷰 후 merge 승인

<Issue 템플릿>
## 개요
무슨 이슈인지에 대한 설명을 적어주세요.

## 기대 결과
- 원하는 결과물에 대한 내용을 적어주세요.

에러 해결 과정은 댓글로 남긴다.

<PR 템플릿>
## 개요
여기에 기능에 대한 간략한 설명을 적어주세요.

## 작업사항
- 여기에 기능에 대한 작업 사항을 적어주세요

## 리뷰 요청사항
- N/A

👩🏻‍💻 코드 컨벤션

• 문자열 처리할 때는 쌍따옴표를 사용
• 문장이 종료될 때는 세미콜론 (;) 사용
• 가독성을 위해 한줄에 하나의 문장만 작성
• 주석은 설명하려는 구문에 맞춰 들여쓰기

// Good
function someFunction() {
  ...

  // statement에 관한 주석
  statements
}

• 연산자 사이에는 공백을 추가하여 가독성 높이기

a+b+c+d // bad
a + b + c + d // good

• 콤마 다음에 값이 올 경우 공백을 추가하여 가독성 높일 것

const arr = [1,2,3,4]; //bad
const arr = [1, 2, 3, 4]; //good

• 생성자 함수명의 맨 앞글자는 대문자로 할 것

function Person(){}

🖇 참고

코딩컨벤션