코딩 컨벤션

• 변수, 함수, 파일명 : camelCase 사용

• 클래스, 컴포넌트 : PascalCase 사용

• 상수(메세지, 환경변수) : SNAKE_CASE 사용(대문자)

• FE - ESlint Airbnb Rules 적용 : https://eslint.org/docs/latest/rules/

• Prettier

  • Rules

  {
    "singleQuote": true,
    "tabWidth": 2,
    "trailingComma": "all",
    "useTabs": false,
    "semi": true,
    "arrowParens": "always"
  }
  

• 변하지 않는 변수는 되도록 const 사용, 나머지는 let사용

• constant한 값 하드코딩 지양, 변수 사용하기

• 화살표 함수만 사용, 함수명은 동사로 짓기

  // ❌ Bad
  function userData() {
  	...
  }
  

  // ✅ Good
  const loadUserData = () => {
  	...
  }
  

• 과도한 축약어 사용하지 않기

  // ❌ Bad
  Users.forEach((u, i) => ...)
  

  // ✅ Good
  Users.forEach((user, index) => ...)
  

• 한 함수는 한가지 액션만 수행하기

깃랩 컨벤션

깃모지 활용

• 깃모지 config

  // setting.json
  "gitmoji.addCustomEmoji": [
    {
      "emoji": "✨ feat:",
      "code": ":feat",
      "description": "새로운 기능 추가"
    },
    {
      "emoji": "🔥 remove:",
      "code": ":remove",
      "description": "기능 삭제"
    },
    {
      "emoji": "📝 docs:",
      "code": ":docs",
      "description": "문서 수정"
    },
    {
      "emoji": "🐛 fix:",
      "code": ":fix",
      "description": "버그 픽스"
    },
    {
      "emoji": "🎨 style:",
      "code": ":style",
      "description": "코드 포매팅, 세미콜론 누락 등 코드 변경이 없는 경우"
    },
    {
      "emoji": "♻ refactor:",
      "code": ":refactor",
      "description": "리팩토링"
    },
    {
      "emoji": "🎉 init:",
      "code": ":init",
      "description": "초기설정"
    },
    {
      "emoji": "🚀 deploy:",
      "code": ":deploy",
      "description": "배포"
    }
  ],
  
  "gitmoji.onlyUseCustomEmoji": true,
  "gitmoji.outputType": "emoji",
  "gitmoji.showEmojiCode": false
  

• Commit type

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • remove : 기능 삭제
  • docs : 문서 수정
  • style : 코드 포매팅, 세미콜론 누락 등 코드 변경이 없는 경우
  • refactor : 리팩토링
  • init : 초기설정
  • deploy : 배포

• Commit 메세지 구조

  1. 제목
     • 제목은 50자 이내, 마침표 및 특수기호 사용하지 않기
     • 개조식 구문으로 작성(서술형 문장이 아니라 간결하고 요약적으로 작성)
  2. 바디
     • 한 줄 당 72자 이내
     • 양에 구애받지 않고 최대한 상세하게 작성
     • fix - 무엇을 변경했는지, 왜 변경했는지 설명

  :feat: 회원가입 기능 추가
  
  이메일 중복확인 기능, 비밀번호 유효성 검사 기능 구현
  

• Branch 전략

  • main > dev > feature-(기능)