Skip to content

이슈 & PR 컨벤션

Min_ehfdl edited this page Oct 12, 2022 · 4 revisions

순서

1. 태그 🏷

태그 의미 상세 설명 이모지명
Feat✨ 새로운 기능 추가   :sparkles:
Fix🐞 버그 수정   :beetle:
Docs📚 문서 수정   :books:
Design🎨 UI 디자인 변경   :art:
Refactor♻️ 코드 리팩토링 파일분리, 모듈화, 아키텍처 변경, 프레임 워크 적용 :recycle:
Chore🧹 자질구레한 수정사항   :broom:
Setting⚙️ 패키지 추가 등 세팅 관련   :gear:
HOTFIX🚑 급하게 치명적인 버그를 고쳐야 하는 경우   :ambulance:

2. 이슈 💡

  • JIRA의 task에 해당됨
  • Github와 연동할 수 있도록 연구해서 추후 업데이트 예정

제목

[Tag] 태스크 내용

예) [Feat] Apple Login 구현

이슈 템플릿

새로운 기능 추가 [FEAT]

---
name: Issue Template
about: 기본 이슈 템플릿
title: "[FEAT]"
labels: ''
assignees: ''

---

## 💡 Issue
<!-- 이슈에 대한 내용을 설명해주세요. -->

## 📝  todo
- [ ] todo
<!-- 해야 할 일들을 적어주세요. -->

## 📸 Screenshot
<!-- 관련된 Figma Screenshot을 추가해주세요. -->
<img width=”250” src=””>

버그 [BUG]

---
name: Bug report
about: File a bug report
title: "[BUG]: "
labels: 'bug'
assignees: 'Lia316'
---

## 문제 상황 

## 영상
<!-- 버그 영상을 추가해주세요.-->
<img width=”250” src=””>

## 시도해본 방법

헬프 [HELP] (진.짜. 헬프)

---
name: Help Template
about: 개발 중 도움이 필요한 사항을 작성합니다.
title: "[HELP]"
labels: ''
assignees: ''

---

## 🥲 Help
<!-- 도움이 필요한 부분에 대해 설명해주세요(파일의 위치, 어려운 부분 포함!) -->

## 📝 Reference
<!-- 참고할만한 자료를 찾아서 넣어주세요. -->

슬랙: 가짜헬프

3. PR 📮

제목

[Tag] 태스크 내용

예시) [Feat] 애플 로그인 기능 추가    

템플릿

## 작업내용
<!-- 작업 내용과 이미지를 첨부해주세요. -->
- [ ] 작업 내용

<!-- (+스크린샷)이 있다면 적어주세요. 없으면 지워주세요-->
|작업 전|작업 후|
|:---:|:---:|
|<img width=”250” src=””>|<img width=”250” src=””>|

## 리뷰포인트
<!-- 리뷰가 필요한 포인트와 해당 되는 커밋을 링크로 걸어주세요. -->

## Reference
<!-- 참고한 자료를 작성해주세요 -->

## Checklist
- [ ] 브랜치를 가져와 작업한 경우 이전 브랜치에 PR을 보냈는지 확인
- [ ] 빌드를 위해 SceneDelegate 수정한 것 PR로 올리지 않았는지 확인
- [ ] 필요없는 주석, 프린트문 제거했는지 확인
- [ ] 컨벤션 지켰는지 확인
- [ ] final, private 제대로 넣었는지 확인
- [ ] Xcode Team none 으로 되어있는지 확인

머지 후

  • 브랜치 삭제하기 (원격 브랜치)

git push {원격 저장소} --delete {삭제할 브랜치}