Skip to content

팀 개발 규칙

backward99 edited this page Sep 8, 2023 · 37 revisions

작업 진행 순서

  1. issue에서 작업을 등록한다. ex. 회원가입 로직 작업
  2. issue에서 태그를 등록한다.(작업자, project 등...)
  3. issue 작업자가 branch 생성을 한다. ex.회원가입-로직-작업

브랜칭 전략

스크린샷 2023-09-04 오후 4 48 43

github flow 전략을 응용하여 develop branch를 추가해 사용한다.

main - develop - 작업 브랜치

merge 방식

  • maindevelop : create a merge commit
  • developother branch : squash and merge

브랜치 생성, merge, 브랜치 삭제는 본인이 직접!

예시

- 회원가입 로직 관련 기능 개발
  - 브랜치: `회원가입-로직-기능`
  - 커밋: `feat: 회원가입 컴포넌트 구현`, `fix: 회원가입 로직 수정`
  - squash and merge
  - 브랜치 삭제

- 프로필 에러 관련 수정
  - 브랜치: `사용자-프로필-에러-수정`
  - 커밋: `fix: 사용자 닉네임 변경 작업`, `chore: 안쓰는 파일 제거`
  - squash and merge
  - 브랜치 삭제

스프린트 마지막날에 develop에서 main 으로 머지한다.

커밋 컨벤션

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

ex. feat: 로그인 기능 추가

태그 이름 설명
feat 새로운 기능을 추가할 경우
fix 버그를 고친 경우
refactor 리팩토링한 경우(리팩토링 과정에서 파일 삭제, 이동 포함)
style CSS 등 사용자 UI 디자인 변경
docs 문서를 수정한 경우
chore 이외의 것들

코드 컨벤션

이름 관련 규칙

props 네이밍

  • props 타입 별칭: 컴포넌트명 + Props로 통일한다.
  • 함수 작성 방식: 함수 표현식을 사용한다.
  • export default는 코드 마지막 줄에 추가한다.
interface TempProps {
  ...
}

### `pages` 네이밍

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

export default Temp

스타일 관련 규칙

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

폴더 관련 규칙

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

이슈 규칙

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

PR 규칙

  • 최소 1명의 승인을 받아야 한다.
  • PR 제목에는 컨벤션 태그 붙이지 않는다.
  • 레이블과 리뷰이만 지정한다.

merge 규칙

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

추가 예정...

childrenReact.ReactNode로 한다.

Clone this wiki locally