Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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)**
- 이전에 유사한 오류가 있었는지?
- 회피 방법(임시 해결책)이 있는 경우
- 이 버그가 프로젝트 전체에 어떤 영향을 미치는지
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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)**
- 문서를 읽는 사용자 입장에서 헷갈렸던 점
- 다른 프로젝트 문서와 비교했을 때 좋은 포맷, 구조 등이 있다면

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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)**
- 문서, 테스트, 성능, 호환성 등에 대한 우려사항
- 사용자 영향, 마이그레이션 이슈 등이 있다면
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -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 특성, 데이터 스키마 복잡성, 사용자 환경 등