혼콕 HONKOK

작업 진행 순서

1. issue에서 작업을 등록한다.  ex. 회원가입 로직 작업

2. issue에서 태그를 등록한다. (작업자, project 등...)

3. issue 작업자가 branch를 생성한다. ex. feat/회원가입-로직-작업

브랜칭 전략

• github flow 전략을 응용하여 develop branch를 추가해 사용한다.
main - develop - 작업 브랜치

merge 방식

• main ← develop : create a merge commit

• develop ← other branch : rebase and merge

ex.
- 회원가입 로직 관련 기능 개발
    - 브랜치: `feat/회원가입-로직-기능`
    - 커밋: `feat` `fix` `refactor` 등 다양하게 커밋
        - `feat: 회원가입 컴포넌트 구현`
    - squash and merge
    - 브랜치 삭제

- 프로필 에러 관련 수정
    - 브랜치: `fix/사용자-프로필-에러-수정`
    - 커밋: `fix`
    - squash and merge
    - 브랜치 삭제

merge 컨벤션

• merge 제목에는 컨벤션 태그를 사용한다.

• ✅ feat: 유저 정보 관련 작업

• ❎ 유저 정보 관련 작업

커밋 컨벤션

• 모든 커밋 내용은 한글로 작성한다. (영어 파일명을 포함시키는 것은 괜찮음)

• 모든 커밋은 한 줄, 명령조로 작성한다.

네이밍 규칙

props 네이밍

• props 타입 별칭: 컴포넌트명 + Props로 통일한다.

• 함수 작성 방식: 함수 표현식을 사용한다.

• export default는 코드 마지막 줄에 추가한다.

interface TempProps {
  ...
}

const Temp = ({ name }: TempProps) => {
  ...
}

export default Temp

배열 데이터 네이밍

• 배열은 List를 붙인다.

• 아이템은 Item을 붙인다.

• api일 경우에는 List가 아닌 s를 붙인다.

• 파일명: PostList, PostItem

• api: posts/{postId}

타입 네이밍

type Temp = number

import, export 규칙

• 같은 폴더에 있는 파일은 상대 경로(./*)를 사용한다.

• 다른 폴더에 있는 파일은 절대 경로(~/*)를 사용한다.

스타일 관련 규칙

• css 크기 단위는 rem으로 통일한다.

폴더 관련 규칙

• index파일은 import/export 용도로 사용한다.

타입 규칙

기타

• ✅ handleClick

• ❎ handleOnClick

PR 규칙

• 최소 1명의 승인을 받아야 한다.

• PR 제목에는 컨벤션 태그 붙이지 않는다. (레이블과 리뷰에 지정한다.)

이슈 컨벤션

• 이슈 제목에는 컨벤션 태그를 붙이지 않는다.

• ✅ 유저 정보 관련 작업

• ❎ feat: 유저 정보 관련 작업

Github 템플릿

• Issue 템플릿

## 내용 설명

## 작업 내용
	- 작업 1
	- 작업 2

• PR 템플릿

## 간단한 내용 설명

## 구현 내용

<!-- ## 스크린샷 -->

<!--## 장애물 -->

## PR 포인트<!--리뷰어가 집중했으면 하는 부분 -->

## 참고 사항<!--특이 사항이나 리뷰어가 알고 있으면 좋을 것 같은 내용 -->

## 궁금한 점

<!-- ## 이슈 번호 close -->

<!--## 테스트 계획 또는 완료 사항-->