From e14bdbc925058dc84e6b468e5ec6eb77175d22b6 Mon Sep 17 00:00:00 2001 From: Jinwon Choi <57012734+kelly-chui@users.noreply.github.com> Date: Thu, 26 Jun 2025 23:32:45 +0900 Subject: [PATCH 1/2] =?UTF-8?q?[docs]=20#88=20=EC=9D=B4=EC=8A=88=20?= =?UTF-8?q?=ED=85=9C=ED=94=8C=EB=A6=BF=20=EC=88=98=EC=A0=95,=20=EC=B6=94?= =?UTF-8?q?=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 리팩토링, 리디자인, 리빌드 - 문서화 - 테스트 - chore 템플릿을 추가했습니다. --- .github/ISSUE_TEMPLATE/bug_report.md | 40 ++++++++++++------- .github/ISSUE_TEMPLATE/chore.md | 24 +++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 25 ++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 23 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---------- .../refactor-redesign-rebuild.md | 24 +++++++++++ .github/ISSUE_TEMPLATE/test.md | 28 +++++++++++++ 7 files changed, 149 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/chore.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md create mode 100644 .github/ISSUE_TEMPLATE/test.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fbee0bb3..b029490d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,22 +1,32 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' +title: "[Bug]" +labels: bug report ‼️ assignees: '' --- -## 🪲 Bug - -> 어떤 버그인지 간결하게 설명해주세요 - -## 상황 - -> (가능하면) Given-When-Then 형식으로 서술해주세요 - -## 예상 결과 - -> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요 - -## 참고할만한 자료(선택) +## ❗ 버그 설명 +> 어떤 버그인지 간결하게 설명해주세요. + + +## 🔁 상황 재현 +> 어떤 상황에서 이 버그가 나타나는지 순서대로 써 주세요. + + +## 🎯 예상한 동작 +> 원래 어떻게 동작했어야 하나요? + + +## 🖥️ 환경 +> 앱 버전, OS, 기기(시뮬레이터) 정보 등을 적어주세요. + +- 기기: +- iOS 버전: +- 앱 버전: +- 네트워크 상태: + +## 🔗 참고할만한 자료 +> 관련된 문서, 이슈, 스크린샷, 링크 등이 있으면 첨부해주세요. + diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md new file mode 100644 index 00000000..831049cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/chore.md @@ -0,0 +1,24 @@ +--- +name: Chore +about: Perform maintenance tasks like CI, configs, or dependencies +title: "[Chore]" +labels: "chore \U0001F439" +assignees: kelly-chui + +--- + +## 🧹 작업 개요 +> 어떤 작업인지 간단히 설명해주세요. + + +## ⚙️ 작업 목적 +> 이 작업을 하는 이유나, 예상되는 효과를 작성해주세요. + + +## 🔧 변경 범위 +> 영향을 받는 설정 파일, 스크립트, 시스템 등을 작성해주세요. + + +## 📝 기타 (선택) +> 추가적으로 공유하고 싶은 정보가 있다면 작성해주세요. + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..f09b46b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,25 @@ +--- +name: Documentation +about: Add or update documentation and developer guides +title: "[Docs]" +labels: documentation +assignees: kelly-chui + +--- + +## 📌 문서 작업 개요 +> 어떤 문서를 추가하거나 수정하려는지 간단히 설명해주세요. + + +## 🗂️ 작업 대상 +> 수정 대상이 되는 문서 또는 위치를 명시해주세요. +> 예: README, API 문서, Swift 파일 주석 등 + + +## ✏️ 변경 내용 +> 어떤 내용을 어떤 이유로 변경하거나 추가하는지 작성해주세요. + + +## 🔗 참고 링크 또는 자료 +> 문서화에 참고한 링크, 도큐먼트 등이 있다면 첨부해주세요. + diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..b9227bb6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,23 @@ +--- +name: Feature +about: Suggest a new feature or improvement +title: "[Feature]" +labels: "feature \U0001F996" +assignees: '' + +--- + +## 📌 Issue +> 추가하려는 기능에 대해 간결하게 설명해주세요. + + +## ✅ 작업 상세 내용 +> 필요한 작업 단위를 체크박스로 구체화해주세요. + +- [ ] TODO +- [ ] TODO +- [ ] TODO + +## 🔗 참고할만한 자료 +> 관련된 문서, 이슈, 스크린샷, 링크 등이 있으면 첨부해주세요. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index b60cb3a1..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -## 📌Issue - -> 추가하려는 기능에 대해 간결하게 설명해주세요 - -## ✅작업 상세 내용 - -- [ ] TODO -- [ ] TODO -- [ ] TODO - -## 참고할만한 자료(선택) diff --git a/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md b/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md new file mode 100644 index 00000000..15b129e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md @@ -0,0 +1,24 @@ +--- +name: Refactor/Redesign/Rebuild +about: Modify internal structure without changing behavior +title: "[Refactor]" +labels: refactor +assignees: '' + +--- + +## 🧩 작업 개요 +> 어떤 부분을 리팩토링/리디자인/리빌딩 하려는지 간단히 설명해주세요. + + +## 🔧 작업 배경 / 이유 +> 왜 이 작업이 필요한가요? 어떤 문제나 불편함을 개선하고자 하나요? + + +## ✅ 예상 작업 범위 +> 예상되는 변경 영역을 적어주세요. + + +## 💬 기타 논의 사항 +> 구현 방식에 대해 논의하고 싶은 점, 기술적 고민 등이 있다면 자유롭게 작성해주세요. + diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md new file mode 100644 index 00000000..ca4cb07a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test.md @@ -0,0 +1,28 @@ +--- +name: Test +about: Add, modify, or improve automated tests +title: "[Test]" +labels: test +assignees: kelly-chui + +--- + +## 🧪 테스트 목적 +> 어떤 기능이나 로직에 대한 테스트를 작성하려는지 간단히 설명해주세요. + + +## 🔍 테스트 대상 +> 테스트하려는 메서드, 모듈, 뷰 등을 구체적으로 작성해주세요. + + +## ✅ 테스트 방식 +> 유닛 테스트, UI 테스트, 통합 테스트 중 어떤 방식으로 검증할지 적어주세요. + + +## 🧱 예상 테스트 케이스 (선택) +> 커버하고자 하는 시나리오나 엣지 케이스가 있다면 적어주세요. + + +## 💬 기타 논의 사항 (선택) +> 테스트 작성 시 논의할 부분이 있다면 자유롭게 작성해주세요. + From c3d01baca507ec80e0aedf19838a0c0aaad604a5 Mon Sep 17 00:00:00 2001 From: Jinwon Choi Date: Thu, 26 Jun 2025 23:49:37 +0900 Subject: [PATCH 2/2] =?UTF-8?q?[docs]=20#88=20=EC=9D=B4=EC=8A=88=20?= =?UTF-8?q?=EA=B0=84=EB=8B=A8=ED=95=98=EA=B2=8C=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 불필요한 섹션이 많은 것 같아 통합했습니다. --- .github/ISSUE_TEMPLATE/chore.md | 4 ---- .github/ISSUE_TEMPLATE/documentation.md | 6 +----- .github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md | 8 ++------ .github/ISSUE_TEMPLATE/test.md | 6 +----- 4 files changed, 4 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md index 831049cc..95b7e3ee 100644 --- a/.github/ISSUE_TEMPLATE/chore.md +++ b/.github/ISSUE_TEMPLATE/chore.md @@ -11,10 +11,6 @@ assignees: kelly-chui > 어떤 작업인지 간단히 설명해주세요. -## ⚙️ 작업 목적 -> 이 작업을 하는 이유나, 예상되는 효과를 작성해주세요. - - ## 🔧 변경 범위 > 영향을 받는 설정 파일, 스크립트, 시스템 등을 작성해주세요. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index f09b46b5..bc449f8c 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -8,7 +8,7 @@ assignees: kelly-chui --- ## 📌 문서 작업 개요 -> 어떤 문서를 추가하거나 수정하려는지 간단히 설명해주세요. +> 어떤 문서를 추가하거나 수정하려는지 이유와 함께 간단히 설명해주세요. ## 🗂️ 작업 대상 @@ -16,10 +16,6 @@ assignees: kelly-chui > 예: README, API 문서, Swift 파일 주석 등 -## ✏️ 변경 내용 -> 어떤 내용을 어떤 이유로 변경하거나 추가하는지 작성해주세요. - - ## 🔗 참고 링크 또는 자료 > 문서화에 참고한 링크, 도큐먼트 등이 있다면 첨부해주세요. diff --git a/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md b/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md index 15b129e8..36784151 100644 --- a/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md +++ b/.github/ISSUE_TEMPLATE/refactor-redesign-rebuild.md @@ -7,12 +7,8 @@ assignees: '' --- -## 🧩 작업 개요 -> 어떤 부분을 리팩토링/리디자인/리빌딩 하려는지 간단히 설명해주세요. - - -## 🔧 작업 배경 / 이유 -> 왜 이 작업이 필요한가요? 어떤 문제나 불편함을 개선하고자 하나요? +## 🔧 작업 배경 및 개요 +> 어떤 이유로 이 작업을 하게 되었고, 무엇을 개선하려고 하는지 설명해주세요. ## ✅ 예상 작업 범위 diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md index ca4cb07a..3e7f9c9c 100644 --- a/.github/ISSUE_TEMPLATE/test.md +++ b/.github/ISSUE_TEMPLATE/test.md @@ -8,11 +8,7 @@ assignees: kelly-chui --- ## 🧪 테스트 목적 -> 어떤 기능이나 로직에 대한 테스트를 작성하려는지 간단히 설명해주세요. - - -## 🔍 테스트 대상 -> 테스트하려는 메서드, 모듈, 뷰 등을 구체적으로 작성해주세요. +> 어떤 기능이나 로직에 대한 테스트를 작성하려는지 대상과 함께 간단히 설명해주세요. ## ✅ 테스트 방식