From b883f634830d75e1b7152651772a9411be8158f7 Mon Sep 17 00:00:00 2001 From: Junjie Mao Date: Wed, 24 Sep 2025 10:13:34 +0800 Subject: [PATCH] Add AI contributing guide Signed-off-by: Junjie Mao --- .../content/doc/projects/ai_contributing.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 sig/TC/content/doc/projects/ai_contributing.md diff --git a/sig/TC/content/doc/projects/ai_contributing.md b/sig/TC/content/doc/projects/ai_contributing.md new file mode 100644 index 00000000..cbdb1a59 --- /dev/null +++ b/sig/TC/content/doc/projects/ai_contributing.md @@ -0,0 +1,39 @@ +# 龙蜥社区重点AI上游训推框架贡献指引 + +## 工作代码仓 + +龙蜥社区在GitHub上提供统一的工作代码仓，用于在合作伙伴之间共享建设中的代码，并在代码完善后向上游提交贡献请求（即Pull Request）。 + +| AI训推框架项目 | 龙蜥社区工作代码仓地址 | +| ------------------- | ------------------------------------------ | +| SGLang | https://github.com/openanolis/sglang/ | +| DeepSpeed | https://github.com/openanolis/DeepSpeed | +| vLLM | https://github.com/openanolis/vllm | +| Mooncake | https://github.com/openanolis/Mooncake | +| PyTorch | （后续开放） | + +工作代码仓默认只读，各合作伙伴在[GitHub龙蜥组织](https://github.com/openanolis)下拥有一个AI工作组，工作组成员可以按照一定的命名规范在工作代码仓中创建、修改或删除分支。分支的命名规则和权限设置如下： + +* 各AI工作组的分支名必须带有命名空间，如`<命名空间>/<其它信息>`；命名空间可以有多个层级，如`<命名空间>/<子命名空间>/<其它信息>`； +* 无命名空间的分支仅管理员可写； +* AI工作组的成员可以在工作仓中创建、修改或删除以该组任一成员的GitHub ID为一级命名空间的分支； +* 一个AI工作组的成员不允许在其它工作组命名空间下创建、修改或删除分支。 + +如需在GitHub龙蜥组织下创建AI工作组，请私信联系@junjiemao，告知希望创建的工作组名称与管理员的GitHub账号。 + +## 贡献请求（Pull Request）提交指引 + +在第一次提交贡献请求之前，请确保完成下列步骤： + +1. 创建GitHub账号（如已有GitHub账号可跳过此步）； +2. 登录该账号，在[Account Security](https://github.com/settings/security)页面启用该账号的Two-Phase Authentication； +3. 在[SSH and GPG keys](https://github.com/settings/keys)页面上传SSH public key，用于后续上传分支时的认证； +4. 将该GitHub账号ID告知你所在合作伙伴的工作组管理员，以获取加入AI工作组的邀请。 + +完成上述步骤后，即可在GitHub 龙蜥组织下的工作代码仓创建分支，并从该分支向上游发起贡献请求。具体流程参见[Beginner’s guide to GitHub: Creating a pull request](https://github.blog/developer-skills/github/beginners-guide-to-github-creating-a-pull-request/)。 + +## 龙蜥社区AI工作组列表 + +| GitHub 龙蜥社区 AI 工作组 | 管理员（GitHub ID） | +| -------------------------------- | ------------------------ | +| alibaba-ai | 茅俊杰（banxingmjj） | -- Gitee