git 정리

git 전략 : git flow / github flow(오픈소스 라이브러리에서 많이 사용) / gitlab flow 

 

** git flow를 많이 사용 (단점은 CI/CD할 때 불편하다고 함)

 

** Commit Convention

 

  1. 가급적 제목은 영어로

  2. 제목과 내용 사이 빈 줄

  3. 현재형으로 작성

  4. 제목에는  type을 꼭 지정

  5. 내용은 문장형으로 작성

  6. merge, revert commit은 미리 작성된 내용을 건드리지 말 것

  7. {type} : Title

  8. types

       가. feat : features

       나. docs : documentations

       다. conf : configurations

       라. style : formatting, semicolon, ..  // css의 style이 아님  코드의 변경이 아니라 코드의 모양이 변경된 것

       마. refactor : refactoring

       바. test : test code

       사. chore : build, package manager

 

** Issue template

       ## Description(설명)

       ## Tasks(New feature)

       - [   ]  Item1

      ## References

      [link text] (link addr)

 

** PR template

 

    ## Motivation

    close or resolve or fix(fixed, fixes) #{issue number}

    ## Key Changes

    - Changes

    ## To reviewers

 

** Sane Issue Label

 

   1. Status

       - Accepted : 애자일 프로세션 중에 의사결정된 단계

       - Available : 이 기능이 누구라도 사용해도 되는상태

       - Blocked : 누구도 사용못하게 막은 상태

       - Completed : 일이 완전히 끝난 상태

       - In Progress : 누가 이일을 잡았고 진행하는 상태

       - On hold : 누군가 다른 일을 하게되서 중단된 상태

       - Pending : asign이 있고 없고 차이??

       - Review Needed : 일이 끝나서 코드리뷰를 하면되는 상태

       - Revision Needed : 이 일을 다시 해야하거나 업데이트해야하는 부분이 필요한 상태

   2. Type 

       - Bug :

       - Documentation :

       - Feature :

       - Idea :

       - Maintenance :

       - Question :

   3. Priority (High, Medium, Low 중 선택)

       - Critical : 핫 픽스?? // 진돗개 하나 발령 모든 직원이 이 일을 해야하는 상황

       - High : 

       - Medium : 

       - Low : 

   4. For (어떤분야 카테고리에 포함되는냐)

       - API : 

       - Backend : 

       - CI/CD : 

       - CLI : 

       - Frontend :

 

** Branch Protectrion(휴먼에러를 방지하기 위한 방법) // 레직스 엔진???

       - *release : release로 끝나는 이름 

       - release* : release로 시작하는 이름

       - *release* : release를 포함하는 이름 

       - [^a-zA-Z0-9] : 모든 알파벳+숫자 중 1글자

       - s?y: say, sby, scy, sdy, ..

   

** Good README.md

 

    # Project Name 
    Description(한 줄 설명) 
    See demo [link](link)
    ## Prerequisite // 이 프로젝트를 수행하기 위해서 환경설정 등....
    ## How to start // 인스톨레이션과 스타트 커맨드를 진행시켜서 실제로 작동가능하게 작성해야 함
    ## Features // 어떤 기능들이 있는지 설명
    ## Contributors // 팀원 팀소개 github ID
    ## References // 참고문서 등.... 링크
    ## Licens

 

** Code review : 변수이름 / 컨벤션 / 당사와 코딩스타일 등 정말 꼼꼼하게 보자