Pullanner project - Convention & Git Branch Strategy

Code Convention

🔵 JavaScript

JavaScript Version

• ES6+를 사용합니다.

function

• 화살표 함수를 기본으로 사용합니다.

import

• import문의 순서는 custom eslint rule에 따릅니다.

'import/order': [
      'error',
      {
        groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
        pathGroups: [
          {
            pattern: '@/*',
            group: 'internal',
            position: 'after',
          },
        ],
        'newlines-between': 'always',
        alphabetize: {
          order: 'asc',
          caseInsensitive: true,
        },
      },
    ],

export

• export default는 가장 하단에 작성합니다.
• export는 변수 선언과 함께 작성합니다.

🔵 Naming Convention

constants

• 상수는 대문자로 쓰며 _로 구분합니다.

variables

• 주로 camelCase를 사용합니다.
• 일반적으로는 명사로 시작하되 flag 변수일 경우 is나 has로 시작합니다.
• button 등의 영어 단어의 경우 btn같이 축약하지 않고 그대로 작성합니다.

function

• 기본적으로 camelCase를 사용합니다.
• 생성자 함수의 경우, PascalCase를 사용합니다.
  동사로 시작한다.
• 이벤트 핸들러의 콜백 함수는 handle[컴포넌트이름][이벤트이름]으로 작성합니다.

<DropDown onClick={handleDropDownClick}>

class

• PascalCase를 사용합니다.

interface, type

• PascalCase를 사용합니다.
• prefix(I, T와 같은)를 사용하지 않습니다.

🔵 Type Definition

• type alias를 기본으로 사용합니다. 그 이유는 다음과 같습니다.
  1. type alias는 computed value를 사용할 수 있습니다.
  2. type alias는 IDE에서 마우스 hover 시 미리보기를 더 잘 지원하므로 편리합니다.
  3. type alias는 같은 이름으로 중복 선언할 수 없으므로 원치 않는 선언 병합을 막아줍니다.

type names = 'firstName' | 'lastName'

// type alias에서는 computed value 사용 가능 
type NameTypes = {
  [key in names]: string 
}

// interface에서는 computed value 사용 불가
interface NameInterface {
  // error
  [key in names]: string
}

const yc: NameTypes = { firstName: 'hi', lastName: 'yc' }

• 인터페이스가 필요한 경우, 인터페이스를 사용합니다.
• Component의 Props 타입 지정 시 Props suffix를 붙여서 작성합니다.

Branch Strategy

• 저희 프로젝트에는 Github Flow로 하기로 결정했습니다.
  • 근거
    1. git-flow에 비해 관리하는 브랜치 갯수가 적기 때문에 버전 관리가 쉽습니다.
    2. PR을 통해 팀원과 상의 후 merge해서 main 브랜치에서 배포해도 충분하다고 생각하고 생각했습니다.

# main [Infinite Lifetime]
- 사용자에게 배포된 코드를 관리하는 브랜치
- Tag를 붙여서 release 이력을 관리합니다. 

# feature, refactor, fix [Short Lifetime]
- main 브랜치에서 분기된다.
- 출시를 하기 위해 main에 PR을 보내면 merge될 수 있습니다. 
- Example
	- feature/#15-login
	- refactor/#30-community-page
	- fix/#54-navbar-bug