Skip to content

raymondanythings/github_issue_template

Repository files navigation

Airbnb 코드스타일 가이드 바로가기

레포지토리 초기 세팅


  1. 라벨 설정하기
    npx github-label-sync --access-token <<YOUR_GH_TOKEN>> --labels ./labels.json <<YOUR_REPOSITORY>>
  2. 커밋 템플릿 적용하기
    git config --global core.editor "code --wait"   # 깃 에디터를 vscode로 변경
    git config --global commit.template <.gitmessage.txt 경로>

커밋 컨벤션

  • 템플릿
    🎨feat : 기능 추가 및 개선
    🐛fix : 오류 수정
    💄style : 코드의 수정이 없는 문자포멧팅
    🧪test : 코드 및 기능 테스트
    ♻️refactor : 기존 코드를 수정한 코드정리
    🗑️cleanup : 기존 코드를 수정하지 않은 코드정리
    🚧chore : 환경설정 및 프로젝트 세팅
    
  • regex
    • ^(🎨|🐛|💄|♻️|🗑️|🚧|🧪)(feat|fix|style|refactor|cleanup|chore|test)\s:\s.+
  • 유다시티 커밋컨벤션
    <type>(<scope>): <subject> - Subject line
    <BLANK LINE>               - 줄 바꿈으로 구분한다
    <body>                     - Message body
    <BLANK LINE>               
    <footer>                   - Message footer
    
    1. **Subject line**
       1. 변경 사항에 대한 간단한 설명.
    2. **Message body**
       1. 수정 이유와 전후 비교 설명.  
       2. 명령형 현재 시제로 작성한다. (changed X, change O)
    3. **Message footer**
       1. 주요 변경사항은 푸터에 변화에 대한 상세설명, 정의, 이전 노트와 함께 명시되어야 한다.
       2. 전후를 Before : scope: { ~~ } After : scope: { ~~~ } 와 같이 상세하게 명시한다.
       3. 처리 완료된, 즉 close 된 이슈에 대해서는 `Closes #123, #124` 로 표기한다.

.

리뷰 코멘트 컨벤션

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published