Skip to content

Convention

Gangpyo No edited this page Dec 20, 2021 · 4 revisions

1. 코드 컨벤션

  • 변수 및 함수명 : 카멜케이스
  • 함수정의 : () ⇒ {} ( 화살표함수로 정의할것)
  • 컴포넌트명 : 대문자로 시작, 카멜케이스
  • 파일, 폴더명 : 카멜케이스

2. Git Flow

  • release : 제품을 배포하는 브랜치 입니다.
  • develop : 개발 브랜치로 개발자들이 이 브랜치를 기준으로 각자 작업한 기능들을 합(Merge)칩니다.
  • PR은 오전11시,오후10시에 함
  • commit 메세지는 남들이 알아보기 쉽게 작성하고 단위는 최소화.
  • commit시 수정된파일별 메세지 작성할것.

3. 브랜치 구조 (깃허브)

  • main
    • release
    • dev
      • harin
      • sungmin
      • gangpyo

4. 커밋 메세지

  • commit message rules
    • add : asset, dependency 추가 하는 경우 (이미지 파일)

    • feat : 새로운 기능 추가 + view 포함

    • edit : 코드를 수정한 경우 (fix가 아님)

    • fix : 버그 수정

    • docs : 문서 수정 (readme)

    • style : css style code

    • refactor : 코드 리팩토링

    • chore : 빌드 업무 수정, 패키지 매니저 수정

    • 추가 정보를 전달하고 싶을 경우 본문에 추가 정보 기입

        ex): [feat] :  로그인 뷰 완성
      
    • 작업중인 파일을 commit할경우

      ex) : [feat] : 로그인 뷰(ing)

5. 주의사항

  • 필요없는 코드는 최대한 지우기
  • 공용으로 쓰는 컴포넌트, 페이지 수정했으면 바로 알려줄것.
  • 자신이 맡은 기능이 완료되었으면, 개인 원격브랜치에 푸시
  • merge, conflict 은 다같이
  • 원격 브랜치에 푸쉬후 PR시 알려줄것.

Clone this wiki locally