Rules

목차

1. 작업환경
2. Gitflow
3. Code Rules
4. Commit Rules

---

작업환경

• VSCode
• Prettier (VSCode Extension)

Gitflow

• Branch 구성

  • 메인 브랜치 (프로젝트 기간동안 사라지지 않음)
    • main (only release)
    • develop (default)
  • 서포팅 브랜치 (필요에 따라 생기고 삭제됨)
    • 목적/작업내역 형식
      • added/{작업내역}

      added/popup
      

      • fixed/{작업내역}

      fixed/popup
      

• 작업 플로우

  • issue로 브랜치의 목적 기록
  • 서포팅 브랜치 생성 후 개발
  • 완료 시 develop 브랜치로 Pull Request

• Pull Request

  • 코드리뷰 필수
  • 토의사항은 PR 댓글로
  • Repository에 소속된 모든 담당자가 OK 시 merge

• merge

  • develop 브랜치에 squash merge

Code Rules

• 네이밍 규칙

  • 변수 및 함수
    • camelCase 방식을 사용
    • 변수에 모든 의미를 충분히 담을것

• 코드 스타일 통일 (Prettier 사용)

  {
      "[javascript]": {
          "editor.formatOnSave": true,
  	    "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      "printWidth": 120,
      "tabWidth": 4,
      "singleQuote": true,
      "bracketSpacing": true,
      "semi": true,
      "jsxSingleQuote": true,
      "endOfLine": "auto",
      "useTabs": false,
      "arrowParens": "avoid"
  }
  

• 코드에 주석 X

  • 소스코드를 누구나 이해할 수 있는 수준으로 작성

Commit Rules

• 양식

  {핵심 내용(타이틀)}
  
  - {세부내용}
  - {세부내용}
  

  • 커밋에 별다른 의견이나 메시지가 없을 시 '//WIP' 입력