컨벤션

hzn·2022년 12월 15일
0

etc

목록 보기
13/13
post-thumbnail

🌟 커밋 컨벤션

✨ feat : 파일, 폴더, 새로운 기능 추가
🚑 fix : 버그, 오류 수정
💄 design : 코드 스타일 변경 + CSS 등 사용자 UI 변경
📝 docs : 문서 생성, 추가, 수정 README.md
♻️ refactor: 코드 리팩토링
🎨 style : 코드 포맷 변경, 세미 콜론 누락 등 (프로덕션 코드 변경 X)
🚀 build : 빌드 관련 파일 수정
⚡️ chore : 빌드 테스트 업데이트, 패키지 매니저 설정 (package.json 변경이나 .env의 요소 변경, 모듈 변경 등) (프로덕션 코드 변경 X)
✅ test : 테스트 추가, 수정 (프로덕션 코드 변경 X)
💚 ci : CI 관련 설정 수정

🌈 !BREAKING CHANGE : 커다란 API 변경의 경우
🔥!HOTFIX : 급하게 치명적인 버그를 고쳐야하는 경우
🔨 rename : 파일명 혹은 폴더명 수정
🗑 remove 파일 혹은 폴더 삭제
📌 comment 필요한 주석 추가 및 변경

🌟 코딩 컨벤션

📁 디렉토리 구조

- pages
- components
- constants (상수)
- utils (서비스 로직)
- api
- hooks
- style
- assets
- @types (타입스크립트 사용시)

Function

// rafce
import React from 'react'

const Untitled-1 = () => {
  return (
    <div>Untitled-1</div>
  )
}

export default Untitled-1

Variable 변수

  • 카멜 케이스
const passwordErrorMsg = 'hello';

Contant

  • 전체 대문자, _로 구분
// 비밀번호 검사 관련
export const PASSWORD_ERROR_MSG = [
  '비밀번호는 8글자 이상',
  '영문 대문자 최소 1글자 이상 포함',
  '특수문자 최소 1글자 이상 포함',
];

🌟 브랜치

기능 추가의 경우 feature/ 를 붙이고 그 뒤에 소문자로 브랜치이름을 작성
단어를 두개이상 써야하는 경우에는 대시(-)로 구분
ex) feature/login-page , feature/main-page


레퍼런스

0개의 댓글