Skip to content

Contribution

代码贡献指南

贡献代码

作为一个在快速发展的开源项目，我们非常欢迎各种形式的贡献，无论是文档的改进、新测例的添加、新工具的添加，亦或者是功能的改进，添加或者基础设施的改进。

修复错误

修复代码实现错误的步骤如下：

  1. 如果提交的代码改动较大，建议先提交 issue，并正确描述 issue 的现象、原因和复现方式，讨论后确认修复方案。
  2. 修复错误并补充相应的单元测试，提交 pull request。

新增功能或组件

  1. 如果新功能或模块涉及较大的代码改动，建议先提交 issue，确认功能的必要性。
  2. 实现新增功能，提交 pull request。

文档补充

修复文档可以直接提交 pull request。添加文档或将文档翻译成其他语言步骤如下

  1. 提交 issue，确认添加文档的必要性。
  2. 添加文档，提交 pull request。

贡献流程

如果你对pull request不了解，没关系，接下来的内容将会从零开始，一步一步地指引你如何创建一个 pull request 。如果你想深入了解 pull request 的开发模式，可以参考 github上的教程

复刻仓库

当你第一次提交pull request时，先复刻仓库原代码库。点击 GitHub 页面右上角的 Fork 按钮，复刻后的代码库将会出现在你的 GitHub 个人主页下。

将代码克隆到本地

git clone git@github.com:{username}/LazyLLM.git

添加原代码库为上游代码库

git remote add upstream git@github.com:LazyAGI/LazyLLM.git

检查 remote 是否添加成功，在终端输入 git remote -v

origin  git@github.com:{username}/LazyLLM.git (fetch)
origin  git@github.com:{username}/LazyLLM.git (push)
upstream    git@github.com:LazyAGI/LazyLLM.git (fetch)
upstream    git@github.com:LazyAGI/LazyLLM.git (push)

这里对 origin 和 upstream 进行一个简单的介绍，当我们使用 git clone 来克隆代码时，会默认创建一个 origin 的 remote，它指向我们克隆的代码库地址，而 upstream 则是我们自己添加的，用来指向原始代码库地址。当然如果你不喜欢他叫 upstream，也可以自己修改，比如叫 LazyLLM。我们通常向 origin 提交代码（即 fork 下来的远程仓库），然后向 upstream 提交一个 pull request。如果提交的代码和最新的代码发生冲突，再从 upstream 拉取最新的代码，和本地分支解决冲突，再提交到 origin。

创建开发分支

我们需要基于 main 创建开发分支，建议的分支命名规则为 username/pr_name。

git checkout -b username/pr_name

在后续的开发中，如果本地仓库的 main 分支落后于 upstream 的 main 分支，我们需要先拉取 upstream 的代码进行同步，再执行上面的命令

git pull upstream main

风格和测试

提交的代码需要通过单元测试以保证正确性，并保证代码风格无误。可以执行如下命令:

pytest -vxs tests
python -m flake8

推送代码到远程

将代码推送到远程仓库，如果是第一次推送，可以在 git push 后加上 -u 参数以关联远程分支

git push -u origin {branch_name}
这样下次就可以直接使用 git push 命令推送代码了，而无需指定分支和远程仓库。

提交pull request（PR）

  • 在 GitHub 的 Pull request 界面创建pull request
  • 根据指引修改 PR 描述，以便于其他开发者更好地理解你的修改

注意

  • PR 描述应该包含修改理由、修改内容以及修改后带来的影响，并关联相关 Issue
  • 所有 reviewer 同意合入 PR 后，我们会尽快将 PR 合并到主分支。

解决冲突

随着时间的推移，我们的代码库会不断更新，这时候，如果你的 PR 与主分支存在冲突，你需要解决冲突，解决冲突的方式有两种：

git fetch --all --prune
git rebase upstream/main
或者 
git fetch --all --prune
git merge upstream/main
如果你非常善于处理冲突，那么可以使用 rebase 的方式来解决冲突，因为这能够保证你的 commit log 的整洁。如果你不太熟悉 rebase 的使用，那么可以使用 merge 的方式来解决冲突。

pull request规范

  1. 一个 pull request 对应一个短期分支

  2. 粒度要细，一个 pull request 只做一件事情，避免超大的 pull request

    • Bad：一个PR里补充多个模型所需的所有算子
    • Acceptable：一个PR里实现一个或几个相关算子
    • Good：修复某个算子 input 为空时引发的 bug

  3. 每次 commit 时需要提供清晰且有意义 commit 信息

  4. 提供清晰且有意义的 pull request 描述

    • 标题写明白任务名称，一般格式: [Prefix] Short description of the pull request (Suffix)
    • prefix: 新增功能 [Feature], 修 bug [Fix], 文档相关 [Docs], 开发中 [WIP] (暂时不会被review)
    • 描述里介绍 pull request的主要修改内容，结果，以及对其他部分的影响, 参考 pull request 模板
    • 关联相关的 议题(issue) 和其他 pull request

  5. 如果引入了其他三方库，或借鉴了三方库的代码，请确认他们的许可证和LazyLLM兼容，并在借鉴的代码上补充 This code is inspired from http://