跳到内容

新贡献者指南

这是为Lance项目新贡献者提供的指南。即使您之前没有Python、Rust和开源经验,您仍然可以通过帮助我们改进文档、示例等来做出重要贡献。对于经验丰富的开发者,您可以从事的问题范围从Python和Rust中的热身练习到严峻挑战。

如果您有任何问题,请加入我们的Discord以获得实时支持。我们始终欢迎您的反馈!

入门

  1. 加入我们的Discord并打个招呼
  2. 设置您的开发环境
  3. 选择一个问题进行处理。请参阅https://github.com/lancedb/lance/contribute 以获取适合初次贡献的问题。
  4. 玩得开心!

开发环境

目前Lance是用Rust实现的,并附带一个Python包装器。因此,您需要确保同时设置好两者。

  1. 安装Rust:https://rust-lang.net.cn/tools/install
  2. 安装Python 3.9+:https://pythonlang.cn/downloads/
  3. 安装Protocol Buffers:https://grpc.org.cn/docs/protoc-installation/(请确保您拥有3.20或更高版本)
  4. 安装提交钩子:a. 安装pre-commit:https://pre-commit.git-scm.cn/#install b. 在仓库根目录运行pre-commit install

示例工作流程

  1. Fork仓库
  2. 选择Github issue
  3. 为该issue创建一个分支
  4. 进行您的更改
  5. 从您的fork向lancedb/lance创建Pull Request
  6. 获取反馈并迭代
  7. 合并!
  8. 返回第2步

示例笔记本

示例笔记本位于examples目录下。这些是独立的笔记本,您应该能够下载并运行。

基准测试

我们的Rust基准测试每天运行多次,历史记录可在此处找到。

另外,我们还有针对sift1m数据集的向量索引基准测试,以及tpch的基准测试。这些位于benchmarks目录下。

行为准则

我们遵循Python基金会Rust基金会的行为准则。