Team Rules

Work Rules

Lint 규칙

• .prettierrc

{
  "singleQuote": true,
  "trailingComma": "all"
}

• .eslint

module.exports = {
    parser: '@typescript-eslint/parser',
    parserOptions: {
        project: 'tsconfig.json',
        tsconfigRootDir : __dirname,
        sourceType: 'module',
    },
    plugins: ['@typescript-eslint/eslint-plugin'],
    extends: [
        'plugin:@typescript-eslint/recommended',
        'plugin:prettier/recommended',
    ],
    root: true,
    env: {
        node: true,
        jest: true,
    },
    ignorePatterns: ['.eslintrc.js'],
    rules: {
        '@typescript-eslint/interface-name-prefix': 'off',
        '@typescript-eslint/explicit-function-return-type': 'off',
        '@typescript-eslint/explicit-module-boundary-types': 'off',
        '@typescript-eslint/no-explicit-any': 'off',
    },
};

Ver 관리

• Node.js & npm ver

  • Node.js: 16.17.0(lts)
  • npm: 8.15.1

• Front dependencies & devdependencies ver

• Back dependencies & devdependencies ver

  • express:
  • docker:
  • docker-compose:

작업 파일명(components, styled-component 등) & 생성자명

• Pascal Case 사용
• 이외의 폴더는 Camel Case 사용

변수명

• Camel Case 사용

API 요청

• kebab Case 사용

Git Flow Rules

Commit Message

• 제목과 본문을 한 줄 띄워 분리한다.
• 제목은 영문 기준 50자 이내로 작성한다.
• 제목 첫 글자를 영문 대문자로 작성한다.
• 제목 끝에 .는 금지한다.
• 제목은 명령어로 작성한다.
• 본문은 50자마다 줄을 바꾼다.
• 본문은 어떻게 변경했는지보다 무엇을, 왜 변경했는지에 초점을 맞춘다.

Branch 이름

종류	사용 패턴	특징
main	main	배포 브랜치(production)
dev	dev	production 전 기본 개발 브랜치
feature	feature/issue-No.-작업요약	dev에 병합(PR)
hotfix	hotfix/issue No.	main에 병합

PR 형식

### PR 타입(하나 이상의 PR 타입을 선택해주세요)
- [ ] 기능 추가
- [ ] 기능 삭제
- [ ] 버그 수정
- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 반영 브랜치
ex) feat/login -> dev

### 변경 사항
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

### 테스트 결과
ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다.    
    결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.