chore: add some issue templates (#46)

This commit is contained in:
feihongxu0824 2026-01-30 17:22:11 +08:00 committed by GitHub
parent 18b5a106a7
commit f3db03ffbb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 168 additions and 1 deletions

49
.github/ISSUE_TEMPLATE/benchmark.yml vendored Normal file
View File

@ -0,0 +1,49 @@
name: Benchmarking
description: Add, update, or fix benchmark cases for zvec
title: "[Benchmark]: "
labels: ["benchmark"]
body:
- type: markdown
attributes:
value: |
Use this for benchmark-related work: new test cases, CI integration, or performance regression tracking.
- type: input
id: benchmark_type
attributes:
label: Benchmark Type
description: e.g., filtered search, batch insert, recall@k, ARM64 vs x86
validations:
required: true
- type: textarea
id: goal
attributes:
label: Goal
description: What performance aspect are you measuring or improving?
validations:
required: true
- type: textarea
id: methodology
attributes:
label: Methodology
description: Dataset, query size, hardware, metrics (latency, throughput, memory)
validations:
required: true
- type: textarea
id: baseline
attributes:
label: Baseline (if applicable)
description: Current performance numbers or competing systems for comparison.
validations:
required: false
- type: textarea
id: ci_integration
attributes:
label: CI Integration Plan
description: Should this run in CI? How often?
validations:
required: false

41
.github/ISSUE_TEMPLATE/enhancement.yml vendored Normal file
View File

@ -0,0 +1,41 @@
name: Enhancement
description: Improve an existing feature or component
title: "[Enhance]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
This template is for improving existing functionality (e.g., performance, usability, robustness).
- type: input
id: component
attributes:
label: Affected Component
description: e.g., HNSW index, buffer manager, Python API
validations:
required: true
- type: textarea
id: current
attributes:
label: Current Behavior
description: What is the current state and its limitations?
validations:
required: true
- type: textarea
id: desired
attributes:
label: Desired Improvement
description: What should be improved and how?
validations:
required: true
- type: textarea
id: impact
attributes:
label: Impact
description: How will this benefit users? (e.g., faster queries, lower memory, easier integration)
validations:
required: true

View File

@ -1,7 +1,7 @@
name: Feature Request
description: Suggest a new feature or improvement (e.g., better memory control, new query option)
title: "[Feature]: "
labels: ["enhancement"]
labels: ["feature"]
body:
- type: markdown
attributes:

36
.github/ISSUE_TEMPLATE/integration.yml vendored Normal file
View File

@ -0,0 +1,36 @@
name: Ecosystem Integration
description: Integrate zvec with external frameworks (e.g., LangChain, LlamaIndex)
title: "[Integration]: "
labels: ["integration"]
body:
- type: input
id: framework
attributes:
label: Target Framework
description: e.g., LangChain, LlamaIndex, Haystack
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Why integrate with this framework? Who benefits?
validations:
required: true
- type: textarea
id: interface
attributes:
label: Required Interface
description: What adapter or interface must be implemented? (e.g., VectorStore base class)
validations:
required: true
- type: textarea
id: reference
attributes:
label: Reference Implementations
description: Links to similar integrations in other vector DBs.
validations:
required: false

41
.github/ISSUE_TEMPLATE/profiling.yml vendored Normal file
View File

@ -0,0 +1,41 @@
name: Profiling / Investigation
description: Profile performance, compatibility, or behavior in a specific scenario
title: "[Profile]: "
labels: ["profile"]
body:
- type: markdown
attributes:
value: |
Use this for tasks like performance profiling, architecture compatibility checks, or feasibility studies.
- type: input
id: scenario
attributes:
label: Target Scenario
description: e.g., ARM64 deployment, high-concurrency load, large dataset ingestion
validations:
required: true
- type: textarea
id: objective
attributes:
label: Objective
description: What do you want to learn or validate?
validations:
required: true
- type: textarea
id: methodology
attributes:
label: Proposed Methodology
description: How will you conduct the investigation? (tools, metrics, test data)
validations:
required: true
- type: textarea
id: expected_outcome
attributes:
label: Expected Outcome
description: What deliverables are expected? (e.g., report, optimization PR, benchmark results)
validations:
required: true