Convention - upswp/THXSTORE GitHub Wiki

Git Convention🤙

• commit

  • commit convention : [이슈 번호] 기능 분류 : 상세설명(한글)
  • 기능분류
    • feat : 기능 추가
    • fix : 버그 수정
    • docs : 문서 편집
    • refactor : 리팩토링
    • test : 테스트
    • chore : 그 외

• branch

  • 기존의 git flow 방식을 유지

    • master 🌈

      • 프로젝트 진행상 변화가 있을 때 (단계별 기능 구현이 종료된 시점), 0.x버전으로 업데이트 예정
      • 자율 프로젝트 종료시 1.0.0 버전으로 배포를 최종 목표로함.

    • hotfix 🚨

      • master branch 배포 이후, 긴급한 기능 수정에 있어서 작업 할 경우 사용.
      • 생성 : hofix/타입/기능

    • development 🔥

      • Jenkins를 이용한 배포 자동화 적용 예정

    • feature branch ⭐

      • 생성 : feat/타입/기능
        • 타입 : FE or BE
        • 기능 : FE는 Page 단위로, BE는 기능별로 영문로 작성 (영문작성시 시작 대문자, 합성어는 카멜로 작성)

JIRA Convention🤙

• PM

  • 기본 convention
    • 스프린트 생성을 간트차트를 기반으로 생성한다.
    • 예상한 스프린트의 이슈들을 해당 주차에 실행한다.
    • 스프린트 기간은 간트차트의 기간을 준수한다.
    • 애자일 방식으로 발생하는 이슈들은 상황에 맞게 이슈를 추가하여 관리한다.
    • 이슈현황을 파악하고 그래프로 작업화하여 한눈에 볼 수 있는 환경을 구축한다.
  • 역할
    • 이슈 관리
      • Component기능을 이용해서 FE, BE을 관리한다.
    • 버전 관리
      • Releases 기능을 이용해서 버전을 관리한다.

• MEMBER

  • 기본 convention
    • 1일 스프린트 작업시간을 8시간으로 계산하여 8 Point로 작업한다.
    • 간트차트를 기반으로 예상 이슈를 해당 스프린트에서 관리한다.
    • 애자일 방식으로 발생하는 이슈들을 활성화중인 스프린트에 삽입하여 관리한다.
    • JIRA를 기반으로 스크럼 회의를 진행하며, 항상 최신화된 상태로 진행한다.
  • 역할

    • 이슈 생성

      • 구성요소를 선택하여 이슈를 분류한다 (대시보드를 위해!)
      • 수정버전을 선택한다 (대시보드를 위해 !)
      • 우선순위를 부여한다
      • 담당자를 선택하고, 에픽링크, 스프린트를 연결한다.
      • 이슈가 생성되면 스토리 포인트를 부여한다.

    • 이슈 관리

      • comment 기능을 이용해서 소통한다. @ 멘션 기능을 이용하여 모든 대화가 JIRA를 이용해서 할 수 있도록 한다.

• 작업유형 Convention

  • Epic

    • 해당 이슈을 포괄하는 큰 단위의 업무

  • Story

    • Epic을 수행하기 위한 main 업무

  • Sub-task

    • Story를 수행하기 위한 부작업

  • Task

    • Epic을 수행하기 위한 sub 업무(문서작업, 조사, 학습 등)

Code Convention🤙

• FE

  • Vue_convention

• BE