From f3db03ffbb0630389825e36d0dab64ed97638e87 Mon Sep 17 00:00:00 2001 From: feihongxu0824 Date: Fri, 30 Jan 2026 17:22:11 +0800 Subject: [PATCH] chore: add some issue templates (#46) --- .github/ISSUE_TEMPLATE/benchmark.yml | 49 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.yml | 41 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/integration.yml | 36 ++++++++++++++++ .github/ISSUE_TEMPLATE/profiling.yml | 41 ++++++++++++++++++ 5 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/benchmark.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/integration.yml create mode 100644 .github/ISSUE_TEMPLATE/profiling.yml diff --git a/.github/ISSUE_TEMPLATE/benchmark.yml b/.github/ISSUE_TEMPLATE/benchmark.yml new file mode 100644 index 0000000..0755be8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/benchmark.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 0000000..6c8af7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index ccdda16..1b97e50 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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: diff --git a/.github/ISSUE_TEMPLATE/integration.yml b/.github/ISSUE_TEMPLATE/integration.yml new file mode 100644 index 0000000..8ed39f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/integration.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/profiling.yml b/.github/ISSUE_TEMPLATE/profiling.yml new file mode 100644 index 0000000..f881828 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/profiling.yml @@ -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 \ No newline at end of file