From d93ff651920c8cb51121360ea2caf49f02240cf2 Mon Sep 17 00:00:00 2001 From: ehddnr301 Date: Sat, 13 Sep 2025 13:18:40 +0900 Subject: [PATCH] =?UTF-8?q?Issue=20=ED=85=9C=ED=94=8C=EB=A6=BF=20=ED=8C=8C?= =?UTF-8?q?=EC=9D=BC=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 22 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++ .github/ISSUE_TEMPLATE/performance.md | 29 +++++++++++++++++++++ 4 files changed, 106 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/performance.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a58bfaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: ๐Ÿž Bug Report +about: Lang2SQL ์‚ฌ์šฉ ์ค‘ ๋ฒ„๊ทธ๊ฐ€ ์žˆ์„ ๋•Œ ์•Œ๋ ค์ฃผ์„ธ์š” +title: "[๋ฒ„๊ทธ] [๋ชจ๋“ˆ๋ช… ๋˜๋Š” ๊ธฐ๋Šฅ] ๊ฐ„๋žตํ•œ ์„ค๋ช…" +labels: bug +--- + +### **๋ฒ„๊ทธ ์š”์•ฝ (Summary)** +- ๋ฌด์—‡์ด ์ž˜๋ชป๋˜์—ˆ๋Š”์ง€ ๊ฐ„๋‹จํžˆ ์š”์•ฝํ•ด์ฃผ์„ธ์š”. + +### **์žฌํ˜„ ๋‹จ๊ณ„ (Steps to Reproduce)** +1. ์–ด๋–ค ํ™˜๊ฒฝ์—์„œ (์˜ˆ: ์šด์˜์ฒด์ œ, Python ๋ฒ„์ „, Lang2SQL ๋ฒ„์ „ ๋“ฑ) +2. ๊ตฌ์ฒด์ ์œผ๋กœ ์–ด๋–ค ์ž…๋ ฅ์„ ํ–ˆ๋Š”์ง€ (์ž์—ฐ์–ด ์ฟผ๋ฆฌ, ์„ค์ •, ๋ฒกํ„ฐ DB ์ข…๋ฅ˜, DataHub ์œ ๋ฌด ๋“ฑ) +3. ๊ธฐ๋Œ€ ๊ฒฐ๊ณผ๋Š” ๋ฌด์—‡์ด์—ˆ๋Š”์ง€ +4. ์‹ค์ œ ๊ฒฐ๊ณผ๋Š” ๋ฌด์—‡์ธ์ง€ (์—๋Ÿฌ ๋ฉ”์‹œ์ง€, ๋กœ๊ทธ, SQL ๊ฒฐ๊ณผ, ์†๋„ ๋ฌธ์ œ ๋“ฑ) + +### **ํ™˜๊ฒฝ (Environment)** +- Lang2SQL ๋ฒ„์ „: +- Python ๋ฒ„์ „: +- OS (์˜ˆ: Ubuntu 22.04, macOS 13): +- VectorDB ์ข…๋ฅ˜ ๋ฐ ์„ค์ • (FAISS / pgvector ๋“ฑ): +- DataHub ์„ค์ • ์œ ๋ฌด: +- ๊ธฐํƒ€ ๊ด€๋ จ๋œ ์„ค์ • (์˜ˆ: `.env`, ๊ตฌ์„ฑ ํŒŒ์ผ ๋“ฑ) + +### **์Šคํฌ๋ฆฐ์ƒท / ๋กœ๊ทธ (Screenshots & Logs)** +ํ•„์š”ํ•˜๋‹ค๋ฉด ์—๋Ÿฌ ๋กœ๊ทธ, ์ฝ˜์†” ์ถœ๋ ฅ, ์Šคํƒ ํŠธ๋ ˆ์ด์Šค, ํ™”๋ฉด ์บก์ฒ˜ ๋“ฑ์„ ์ฒจ๋ถ€ํ•ด์ฃผ์„ธ์š”. + +### **์ถ”๊ฐ€ ์ •๋ณด (Additional Context)** +- ์ด์ „์— ์œ ์‚ฌํ•œ ์˜ค๋ฅ˜๊ฐ€ ์žˆ์—ˆ๋Š”์ง€? +- ํšŒํ”ผ ๋ฐฉ๋ฒ•(์ž„์‹œ ํ•ด๊ฒฐ์ฑ…)์ด ์žˆ๋Š” ๊ฒฝ์šฐ +- ์ด ๋ฒ„๊ทธ๊ฐ€ ํ”„๋กœ์ ํŠธ ์ „์ฒด์— ์–ด๋–ค ์˜ํ–ฅ์„ ๋ฏธ์น˜๋Š”์ง€ diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..9b0b3d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,22 @@ +--- +name: ๐Ÿ“š Documentation Issue +about: ๋ฌธ์„œ์˜ ์˜คํƒ€, ๋น ์ง„ ๋‚ด์šฉ, ๊ฐœ์„  ์š”์ฒญ ๋“ฑ +title: "[๋ฌธ์„œ] ๊ฐ„๋‹จํ•œ ์ œ๋ชฉ" +labels: documentation +--- + +### **๋ฌธ์„œ ๋ถ€๋ถ„ (Which part of docs)** +- README, CLI ์‚ฌ์šฉ๋ฒ•, ํŠœํ† ๋ฆฌ์–ผ, API ๋ฌธ์„œ ๋“ฑ +- ํ•ด๋‹น ๋ฌธ์„œ์˜ ๊ฒฝ๋กœ ๋˜๋Š” ํŒŒ์ผ + +### **๋ฌธ์ œ ์„ค๋ช… (What is wrong or missing)** +- ์˜คํƒ€, ์ž˜๋ชป๋œ ์„ค๋ช…, ๋งํฌ ์˜ค๋ฅ˜, ๋น ์ง„ ์˜ˆ์ œ ๋“ฑ + +### **๊ฐœ์„  ์ œ์•ˆ (Suggested Fix)** +- ์–ด๋–ค ๋‚ด์šฉ์„ ์ถ”๊ฐ€/์ˆ˜์ •ํ•˜๋ฉด ์ข‹์„์ง€ +- ์˜ˆ์‹œ ๋ฌธ๊ตฌ, ์Šคํฌ๋ฆฐ์ƒท ๋“ฑ์ด ์žˆ์œผ๋ฉด ์ข‹์Œ + +### **์ถ”๊ฐ€ ์ •๋ณด (Additional Context)** +- ๋ฌธ์„œ๋ฅผ ์ฝ๋Š” ์‚ฌ์šฉ์ž ์ž…์žฅ์—์„œ ํ—ท๊ฐˆ๋ ธ๋˜ ์  +- ๋‹ค๋ฅธ ํ”„๋กœ์ ํŠธ ๋ฌธ์„œ์™€ ๋น„๊ตํ–ˆ์„ ๋•Œ ์ข‹์€ ํฌ๋งท, ๊ตฌ์กฐ ๋“ฑ์ด ์žˆ๋‹ค๋ฉด + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..6a88b6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: โœจ Feature Request +about: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ œ์•ˆ +title: "[๊ธฐ๋Šฅ] ๊ฐ„๋‹จํ•œ ์ œ๋ชฉ" +labels: enhancement +--- + +### **๊ธฐ๋Šฅ ์„ค๋ช… (Description)** +- ์–ด๋–ค ๊ธฐ๋Šฅ์„ ์›ํ•˜์‹œ๋Š”์ง€ ์ƒ์„ธํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”. + +### **์™œ ํ•„์š”ํ•œ๊ฐ€์š”? (Motivation / Use Case)** +- ์ด ๊ธฐ๋Šฅ์ด ํ˜„์žฌ ์ƒํ™ฉ์—์„œ ์–ด๋–ป๊ฒŒ ๋„์›€์ด ๋ ์ง€ +- ์‚ฌ์šฉ ์‹œ ์˜ˆ์ƒ ์‹œ๋‚˜๋ฆฌ์˜ค + +### **์ œ์•ˆํ•˜๋Š” ํ•ด๊ฒฐ ๋ฐฉ๋ฒ• (Proposed Implementation)** +- ๊ฐ€๋Šฅํ•˜๋‹ค๋ฉด ๊ตฌ์ฒด์ ์ธ ์•„์ด๋””์–ด, ์•Œ๊ณ ๋ฆฌ์ฆ˜, ์ธํ„ฐํŽ˜์ด์Šค, UI ํ๋ฆ„ ๋“ฑ +- ์˜ˆ: ์ž์—ฐ์–ด โ†’ SQL ๋ณ€ํ™˜ ์‹œ ํŠน์ • ์กฐ๊ฑด ์ง€์›, ์ƒˆ๋กœ์šด ๋ฒกํ„ฐDB ์œ ํ˜• ์ถ”๊ฐ€, CLI ์ถœ๋ ฅ ํ˜•์‹, etc. + +### **๋Œ€์•ˆ (Alternatives)** +- ๋‹ค๋ฅธ ์ ‘๊ทผ ๋ฐฉ์‹์ด๋‚˜ ๊ธฐ์กด ๋ถ€๋ถ„ ํ™œ์šฉ ๊ฐ€๋Šฅ์„ฑ + +### **์ถ”๊ฐ€ ๊ณ ๋ ค์‚ฌํ•ญ (Additional Context)** +- ๋ฌธ์„œ, ํ…Œ์ŠคํŠธ, ์„ฑ๋Šฅ, ํ˜ธํ™˜์„ฑ ๋“ฑ์— ๋Œ€ํ•œ ์šฐ๋ ค์‚ฌํ•ญ +- ์‚ฌ์šฉ์ž ์˜ํ–ฅ, ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ์ด์Šˆ ๋“ฑ์ด ์žˆ๋‹ค๋ฉด diff --git a/.github/ISSUE_TEMPLATE/performance.md b/.github/ISSUE_TEMPLATE/performance.md new file mode 100644 index 0000000..a173160 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance.md @@ -0,0 +1,29 @@ +--- +name: โšก Performance / Benchmark +about: ์„ฑ๋Šฅ ๋ฌธ์ œ ๋˜๋Š” ๋ฒค์น˜๋งˆํฌ ๊ด€๋ จ ์ด์Šˆ +title: "[์„ฑ๋Šฅ] ๊ฐ„๋‹จํ•œ ์ œ๋ชฉ" +labels: performance +--- + +### **๋ฌธ์ œ ์š”์•ฝ (Summary)** +- ์„ฑ๋Šฅ์ด ๊ธฐ๋Œ€ ์ดํ•˜์ธ ์ง€์  (์ฟผ๋ฆฌ ์ฒ˜๋ฆฌ ์‹œ๊ฐ„, ๋ฉ”๋ชจ๋ฆฌ ์‚ฌ์šฉ๋Ÿ‰, ๋ฒกํ„ฐ DB ์‘๋‹ต ์†๋„ ๋“ฑ) + +### **์žฌํ˜„ ์กฐ๊ฑด (Reproduction)** +- ๋ฐ์ดํ„ฐ ํฌ๊ธฐ (์˜ˆ: ๋ช‡ ๊ฐœ์˜ ํ…Œ์ด๋ธ”, ์นผ๋Ÿผ ์ˆ˜, row ์ˆ˜ ๋“ฑ) +- ์ž…๋ ฅ ๋‚ด์šฉ (์ž์—ฐ์–ด, ๋ชจ๋ธ ์„ค์ •, ๋ฒกํ„ฐ DB ์ข…๋ฅ˜ ๋“ฑ) +- ์‹คํ–‰ ํ™˜๊ฒฝ (ํ•˜๋“œ์›จ์–ด, ๋„คํŠธ์›Œํฌ, ๋ฒ„์ „ ๋“ฑ) + +### **์ธก์ •๊ฐ’ (Metrics)** +- ์‹ค์ œ ์ธก์ •๋œ ์„ฑ๋Šฅ (์‹œ๊ฐ„, ๋ฉ”๋ชจ๋ฆฌ, CPU ๋“ฑ) +- ๊ธฐ๋Œ€ ์„ฑ๋Šฅ ๋˜๋Š” ๋น„๊ต ๋Œ€์ƒ + +### **๊ฐ€๋Šฅํ•œ ์›์ธ (Possible Causes)** +- ์–ด๋””์„œ ๋ณ‘๋ชฉ์ด ์ƒ๊ฒผ๋‹ค๊ณ  ์ƒ๊ฐํ•˜๋Š”์ง€ (์˜ˆ: ๋ฒกํ„ฐ ๊ฒ€์ƒ‰, SQL ์ƒ์„ฑ, ๋ฐ์ดํ„ฐ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ ๋“ฑ) + +### **์ œ์•ˆ๋œ ํ•ด๊ฒฐ ๋ฐฉ์•ˆ (Suggested Fix)** +- ์˜ˆ: ์ธ๋ฑ์Šค ์ถ”๊ฐ€, ์ฟผ๋ฆฌ ์ตœ์ ํ™”, ๋ณ‘๋ ฌ ์ฒ˜๋ฆฌ, ์บ์‹œ ํ™œ์šฉ ๋“ฑ + +### **์ถ”๊ฐ€ ์˜ํ–ฅ ๋ฐ ๊ณ ๋ ค์‚ฌํ•ญ (Additional Context)** +- ์„ฑ๋Šฅ ๊ฐœ์„ ์ด ๋‹ค๋ฅธ ๊ธฐ๋Šฅ์ด๋‚˜ ์•ˆ์ •์„ฑ์— ๋ฏธ์น  ์˜ํ–ฅ +- ๋ฒกํ„ฐ DB ํŠน์„ฑ, ๋ฐ์ดํ„ฐ ์Šคํ‚ค๋งˆ ๋ณต์žก์„ฑ, ์‚ฌ์šฉ์ž ํ™˜๊ฒฝ ๋“ฑ +