Skip to content

Convention

Seungjae Lee edited this page Nov 8, 2022 · 18 revisions

코드 스타일

JS

  • 변수명, 함수명 camelCase
  • 클래스, 컴포넌트명 PascalCase
  • indent, semicolon 여부, … 등
  • tab = 2, prettier, eslint로 강제
  • Prettier
    {
      "singleQuote": false,
      "semi": true,
      "useTabs": false,
      "tabWidth": 2,
      "trailingComma": "es5",
      "printWidth": 120,
      "arrowParens": "avoid"
    }
  • Eslint npx eslint --init 으로 최초 설정 후 prettier, react, react-hooks 관련 설정 추가
    module.exports = {
    env: {
      browser: true,
      es2021: true,
    },
    plugins: ["react", "react-hooks", "@typescript-eslint"],
    extends: [
      "eslint:recommended",
      "plugin:react/recommended",
      "plugin:react-hooks/recommended",
      "plugin:@typescript-eslint/recommended",
      "plugin:prettier/recommended",
    ],
    parser: "@typescript-eslint/parser",
    parserOptions: {
      ecmaVersion: "latest",
      sourceType: "module",
      project: "./tsconfig.json",
    },
    rules: {},
    settings: {
      react: {
        version: "detect",
      },
    },

};

### CSS
- kebab-case
### DB
- snake_case
### 파일, 폴더 명
- 클래스, 컴포넌트인 파일은 PascalCase
- 그 외 파일 및 폴더는 camelCase
### 네이밍
- 리뷰하면서 맞춰보기

# Github 사용 규칙
### 브랜치 전략
- Git-flow (without release)
- main, develop, feature, hotfix
- ![image](https://user-images.githubusercontent.com/102232291/200448921-fd3ae739-77ef-4e6a-be68-b22d0511ccd5.png)

### 커밋 메시지
- git cz 설치하여 사용 → https://www.npmjs.com/package/git-cz
- commit 제목 한글, 명사형
- 세부 내용은 issue를 미리 작성하고 연결

### PR 메시지
- 템플릿으로 관리 (참고 사항 이용해서 이슈 연결)
- PR 메시지
      - 템플릿으로 관리 (참고 사항 이용해서 이슈 연결)
      
      ```markdown
      ---
      name: PR template
      about: PR template
      title: ''
      labels: ''
      assignees: c99-coder, seungjae94, kimhyeongjun95, tnghd5761
      
      ---
      
      ## 작업 내용
      - 
      
      ## 전달 사항
      - 
      
      ## 참고 사항
      - 
      ```
      
  - 이슈 메시지
      - 템플릿으로 관리
      
      ```markdown
      ---
      name: issue template
      about: feature template
      title: ''
      labels: ''
      assignees: c99-coder, seungjae94, kimhyeongjun95, tnghd5761
      
      ---
      
      ## 목적
      
      >
      
      ## 작업 내용
      
      - [ ]
      
      ## 참고 사항
      
      ```
      
  - git project(Todo, In Progress, Done) 사용하여 이슈 관리

📕 메인

👨🏻‍💻 팀 규칙

🛠 프로젝트 명세

👨‍🏫 멘토님 미팅

📝 회의록

1주차 회의록
2주차 회의록
3주차 회의록
4주차 회의록
5주차 회의록
6주차 회의록

📅 스프린트 계획

🔙 회고록

피어세션

2주차 피어세션
3주차 피어세션
4주차 피어세션
5주차 피어세션

💻 기술적 경험

Clone this wiki locally