Convention

Issue Convention

• 이슈 태그: 간단하게 작업 내용 요약
  • ex) Bug: 약속 셀을 눌렀을 때 앱이 꺼지는 문제 상황

이슈 태그	설명
Feat	새로운 기능 추가
Bug	버그를 고쳐야하는 경우
Design	UI 디자인 변경
!HOTFIX	Develop에 급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경과 같이 로직 수정이 없는 코드 스타일 개선
Refactor	코드 로직 개선
Docs	문서 작업
Chore	기타 이슈

Branch Convention

• [작업중인 파일 이름]/[작업 기능]
• 작업을 완료한 브랜치나 사용하지 않는 브랜치는 리모트에서 삭제

Commit Convention

커밋 태그	설명
Feat	새로운 기능을 추가
Fix	버그를 고친 경우
Design	UI 디자인 변경
!HOTFIX	Develop에 급하게 치명적인 버그를 고쳐야하는 경우
Style	코드 포맷 변경과 같이 로직 수정이 없는 코드 스타일 개선
Refactor	코드 로직 개선
Comment	필요한 주석 추가 및 변경
Docs	문서 작업
Chore	위 태그에 해당안되는 수정 내용
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove	파일을 삭제하는 작업만 수행한 경우

PR Convention

• 제목: 핵심작업의 커밋 태그: 간단하게 작업 내용 요약

  • ex) Fix: 약속 셀을 눌렀을 때 앱이 꺼지는 문제 해결

• 본문:

  ### Motivation
  - 작업을 하게 된 배경 소개 (+ 이슈 번호)
  ### Key Change
  - 작업을 한 이후 변화된 점 설명
  - UI 작업의 경우 이미지, GIF, 동영상 등을 함께 첨부
  ### To Reviewers
  - 중점적으로 봐주었으면 하는 코드나 기능, 작업시 주의사항 등과 같이 리뷰어에게 하고싶은 말 자유롭게 기입

👀 참고

• 협업을 위한 git 커밋컨벤션 설정하기