Skip to content

컨벤션 룰

박유현 edited this page Aug 8, 2022 · 6 revisions

컨벤션 룰

커밋

📜커밋 규칙

  • 제목과 본문을 빈 행으로 구분합니다. (한글작성)
  • 제목을 50글자 이내로 제한합니다.
  • 제목의 끝에는 마침표를 넣지 않습니다.
  • 제목은 명령문으로! 과거형을 사용하지 않습니다.
  • 본문의 각 행은 72글자 내로 제한합니다.어떻게 보다는 무엇과 왜를 설명합니다.
  • 커밋Type 앞에 [#이슈번호]를적는다.
[#이슈번호] feat: A 공통 컴포넌트 구현 / feat: A 컴포넌트 구현

본문 작성

📜 커밋 Type

Type 설명
feat 새로운기능 (함수, 컴포넌트) 추가
style CSS스타일 추가, 수정
fix (기능)버그 수정
refactor 변수명, 주석, 기능 변경이 없는 코드 변경
test 테스트 코드, 리펙토링 테스트 코드 추가
docs 문서 수정
chore 빌드 업무 수정, 패키지 매니저 수정, 그 외 자잘한 수정에 대한 커밋

브랜치 & 머지전략

브랜치

  • 크게 develop(개발), main(배포) 브랜치를 나눈다.
  • 개발이 완료되면 main브런치로 머지 시킨다.
  • 브랜치명
    • feature/{issue-number}-{feature-name}
    • feature: 단위별 기능 개발
    • hotfix: 긴급 수정
    • refactor: 리팩토링

머지전략

  • Rebase and Merge

코드 스타일

함수명

  • 동사로 시작

변수명

  • boolean인경우 is, has 로 시작

중괄호

if (n < 0) {
  alert(`Power ${n} is not supported`);
}

가로길이 : 80

들여쓰기

  • 가로: 2
  • 세로: 1

세미콜론: 사용

중첩 레벨

  • 최대 4
  • early return 사용

함수 스타일

  • 화살표함수사용
  • 함수선언 상단에

CSS in JS style

  • 컴포넌트 파일 내부 하단(export default위)에 작성

TS-props

interface명은 컴포넌트명 + Props

interface CardProps { }

템플릿

PR

<!-- 제목 : Feature/#이슈번호-description (미정) -->

# 개요
<!-- 간략 설명 -->

# 작업사항
<!-- 상세 설명 관련이미지 첨부 -->

# 관련 이슈
<!-- 아직 구현되지 않은 기능들, 기능 구현하다 실패한 점, 테스트할 때 유의할 점? -->

# 중점적으로 봐줬으면 하는 부분 (선택 사항)
<!-- 선택사항 사용하지 않을시 제거부탁드려요 -->

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

이슈

<!-- 제목 : [feat/xx페이지] description -->

# 개요
<!-- 간략 설명 -->

# 작업사항
<!-- 상세 설명 관련이미지 첨부 -->

PR 짝꿍

  • 김남경 → 김지은
  • 김지은 → 박유현
  • 박유현 → 유창헌
  • 유창헌 → 김남경