Skip to content

Git Convention

Rey edited this page Jul 28, 2022 · 12 revisions

Commit Message

[label] issue_num : commit message

[feat] #2 : 파도 애니메이션 적용
[bug] #4 : 파도 애니메이션 무한 반복 현상
[fix] #5 : 파도 애니메이션 무한 반복 현상 해결

'#' number : 이슈 번호

Label

bug : 버그 발생 시

conflict : Pull Reqeust 생성 후 Conflict로 Auto Merge가 진행될 수 없을 시

documentation : README.md, Git Template, commit message에 사용 시, ‘docs’로 축약

feature : 새로운 기능 구현

fix : 배포되지 않은 버전에서의 구현된 feature 수정 및 해결

hotfix : 배포 버전에서의 긴급한 버그 수정 및 해결

question : 프로젝트에 대한 모든 질문

help : 프로젝트 진행 중 도움이 필요할 때

reopen : 이슈 & PR이 다시 열렸을 때 or 동일한 내용으로 새로 올렸을 때

prepare : Research for about feature, 작업할 내용에 대한 탐색

refactor : 리펙토링할 경우 사용

undefined : 우선순위가 정의되지 않은 기능에 대해서 작업 시

Issue

하나의 Task는 하나의 Issue로 대응

Issue Template

prepare

  • 레퍼런스
  • 리서치 기간
  • 담당자: Assignees

Feature

  • 제목
  • 내용
  • 구현할 기능
    • prepare Issue#No (optional)
  • 연결될 페이지
  • 우선순위 (칸반에서 중요도)
  • 예상 작업 시간 + 2일 ( 3일을 생각했다면 5일 )
  • 실제 작업 시간 ( 빈칸으로 비워두고 PR전에 작성 ) (default: Empty)
  • 담당자: Assignees

Question & Help

  • 질문
    • prepare Issue#No (optional)
  • 시도해본 내용 or 찾아본 래퍼런스
  • 관련된 파일 또는 페이지
  • 담당자: Assignees

Bug

  • 빌드 기기( 시뮬레이터 or 디바이스 종류, iOS 버전)
  • Xcode Version
  • 페이지
  • 사용된 인터랙션 ( Bug flow )

Fix & Hotfix

  • bug Issue#No (optional)
  • 현재 내용
  • fix 되어야할 내용
    • prepare Issue#No (optional)
  • 예상 작업 시간 + 2일 ( 3일을 생각했다면 5일 )
  • 실제 작업 시간 ( 빈칸으로 비워두고 PR전에 작성 ) (default: Empty)

Undefined

  • 제목
  • 내용
  • 구현할 기능
    • prepare Issue#No (optional)
  • 연결될 페이지

Refactor

  • 제목
  • 내용
  • 하는 이유
  • 예상 작업 시간 + 2일 ( 3일을 생각했다면 5일 )
  • 실제작업시간 (작업 완료 후 작성)

Pull Request Template

  • 작업 내용
  • 기타사항(etc)
  • 연결된(닫힐 Issue)
  • 간략한 Issue의 내용
  • 관련 사진(optional)

Git NickName

스크린샷 2022-07-06 오후 9 24 27
스크린샷 2022-07-06 오후 9 24 37

Edit profile → Name 을 Academy에서 사용하는 NickName으로 바꿔주세요!

  • 터미널 상에서 바꾸는 방법
    • git config user.name ( 닉네임 확인 )

    • git config —global user.name {바꿀 닉네임} ( 닉네임 변경 )

      스크린샷 2022-07-06 오후 9 42 51