博客chevron-rightopenFuyao开源社区入门经验分享

openFuyao开源社区入门经验分享

秦哲2025-04-20

目录 ​

初识openFuyao ​

openFuyao是面向通算和智算集群软件技术创新的开源社区，致力于为世界提供多样化算力集群软件生态，释放智能无限价值，旨在以开放协作汇聚伙伴与开发者，打造多样化算力互联调度能力，实现集群的算力极致释放与安全可靠，孵化基于集群的关键软件根技术，制定统一、开放的技术标准，共创高效、创新的算力集群社区。欢迎访问openFuyao官网和代码仓。

开发环境准备 ​

1. 准备GitCode账号 ​

GitCode是一个代码托管平台，类似于GitHub。我在这里创建了账号，并签署了个人CLA（Contributor License Agreement），（如果您是企业贡献者，请您参考以下说明签署企业贡献者CLA）这是参与开源项目的必要步骤。

  • 在GitCode官网注册GitCode账号：https://gitcode.com/。

    experience1

  • 签署CLA的网址可前往openFuyao官方网站查看：https://cla.openfuyao.cn/sign/67e7c745ea9ceaa8feb65567。

    • 企业贡献者请签署法人贡献者登记，如下例所示:
    experience1-1
    • 个人贡献者请签署签署个人CLA，如下例所示：
    experience1-2

    注：签署CLA的邮箱地址应与GitCode账号关联的“提交邮箱”地址保持一致。所谓GitCode ID即GitCode账号，可以在自己的“个人主页”的URL（Uniform Resource Locator）中查看，如下例所示：

    experience2

    提交邮箱可以在“个人设置|电子邮件”中查看，如下例所示：

    experience3

2. 安装Git工具 ​

接下来，我安装了Git，这是一个版本控制系统，对于开源项目的贡献至关重要。访问Git官网Git - Downloads (git-scm.com)按照提示在您的系统上安装git工具软件（保持默认安装即可）。

experience4

3.配置Git账号 ​

为了让我的身份与我的GitCode账号关联，我配置了我的Git用户名和邮箱。这样，每当我提交代码时，我的信息就会被正确记录。

#用户名设置成GitCode账号
git config --global user.name "your-uesr-name"
#邮箱地址配置成该账号对应的提交邮箱（签署了CLA的邮箱）
git config --global user.email "your-email-address-on-gitcode"
#检查配置后的结果，确认填写信息的正确性
git config --list

示例如下：

git config --global user.name "qinzhe0815"
git config --global user.emile "qinzhe@xxx.com"
git config --list

贡献路线 ​

1. Fork上游仓库 ​

我选择了一个感兴趣并有意向为之做贡献的仓库，将其fork到了我的GitCode账号下。这样，我就有权限在这个仓库上进行更改了。

experience5

  • 点击仓库右上角的 “fork” 按钮即可创建fork仓库。

  • 本例fork到了一个叫qinzhe0815的账号下（您应该fork到自己的账号下）：

    experience6

  • 完成后该仓库会出现在自己的主页下：

    experience7

注：如果之前已经fork该代码仓又想要删除后重新fork，则可以先进入自己的代码仓，然后进入“项目设置”页面，点击“删除项目”选项，在确认操作后，要求对用户进行删除操作确认。校验后即可删除仓库。

在GitCode页面上fork完毕后，下面的步骤在命令行窗口运行git命令。

2. Clone仓库到本地 ​

我使用Git命令将fork后的仓库克隆到本地，这样我就可以开始工作了。

#克隆远程仓库到本地
git clone <仓库的URL>
#进入仓库目录
cd <仓库的本地路径>
#查看当前分支和工作区状态
git status

注：在仓库界面中找到“Clone”，点击可查看仓库的URL。

experience8

示例如下：

git clone https://gitcode.com/qinzhe0815/git-basics.git
cd git-basics
git status

3. 创建新分支 ​

在本地，我创建了一个新的分支，这是进行任何更改前的好习惯。它帮助我隔离开发环境，避免影响到主分支。

#创建并切换到一个新的分支（建议以自己的GitCode ID创建新的分支名）
git switch -c <自定义分支名>
#列出所有的本地分支，并且会标记出当前所在的分支。
git branch
#显示当前分支的状态
git status

示例如下：

git switch -c new-branch
git branch
git status

4. 创建并提交修改 ​

我在仓库的工作目录中创建了一个名为NewFile的空文件，并将其添加到Git暂存区。然后，我提交了这个更改，并推送到了我的远端仓库。

# a) 进入操作的工作目录
# 提前创建好工作目录，对这个仓库的修改都在这个目录进行，不要修改这个目录下的其他文件
cd ./openfuyao/
# b) 建立名为 NewFile 的空文件
cd . > NewFile
# c) 将此文件加入到git暂存区
git add NewFile
# d) 进行commit(可修改记录)
git commit -s -m "Add NewFile"
# e) 推送到自己的远端仓库
git push --set-upstream origin new-branch
# f) 查看状态
git status
git log

注：

（1）“cd .”表示改变当前目录为当前目录，等于没改变，故该操作不会有任何输出。将该输出重定向到一个文件，即创建了一个空文件。

（2）在这个过程中，您需要输入GitCode账号及其登录密码。

（3）在d)步骤中提到了commit的修改，它有多种修改规则，可以使得项目提交历史更简洁，现简单展示其中的“编辑”规则运用：

#修改历史中的某个特定提交，N 是你想要回溯的提交数量，按需修改
git rebase -i HEAD~N
#之后，编译器会自动打开，您可将需要修改的某一条提交记录前的“pick”改为“edit”，保存并关闭，Git 将停止在指定的提交上，让你进行修改
#修改完成后，若继续变基，输入下方命令
git rebase --continue
#重复上述过程，直至修改完毕
#如已修改完毕，输入以下命令，结束变基
git rebase --abort

（4） 如果后续还有commit要推送到远端仓库的话，e) 步骤的命令直接用git push就行了。

5. 提交PR（Pull Request） ​

我将我的更改推送到了远端仓库后，创建了一个Pull Request。这是一个请求，希望项目维护者将我的更改合并到主分支。我填写了标题和注释，详细说明了我的更改内容，具体步骤如下：

  • 切换分支：

    推送到远程仓库之后，自己仓库的代远程码上就会出现自己新建的分支。

    experience9

    鼠标点击这个分支就可以切换到这个分支。（本例是new-branch）。

  • 新建Pull Requests：

    点击“Pull Requests”→“新建Pull Request”。

    experience10

  • 选择自己创建的分支提交PR

    experience11

    （1）选中自己仓库的分支为刚才提交的分支（这里是从自己远端仓库的new-branch分支合并到上游仓库的master分支）。

    （2）并填写标题文字和注释（注释说明此次提交做了哪些改动）。

    （3）然后点击右下角的“Create（创建）”按钮。

    （4）提交成功后原仓库将会显示此次提交：

    experience12

注：为保证提交历史清晰且便于维护，请在提交 PR 时遵循以下提交信息规范：

  • 提交格式：<type>[optional scope]: <description>
  • 常用类型 (type)：feat、fix、docs、style、refactor、perf、test、chore、ci、build
  • 描述 (description)：使用祈使句，简短且说明目的，不以句号结尾
  • 范围 (scope)：可选，用于指明影响的模块或子系统
  • 正文 (body)：可选，如需详细说明变更原因、设计考虑或实现细节，换行书写在正文部分
  • 破坏性变更：若变更会破坏兼容（API 变更、移除功能等），必须在 type/scope 后加 !，并在 body 中添加 BREAKING CHANGE: <描述>
  • PR 标题建议与合并后保留的提交信息一致，PR 描述应包含变更摘要、动机以及影响范围（如有迁移步骤或需注意事项请列出）

以下列举一些提交信息示例：

  • 示例 1 — 新功能（带 scope）
    feat(auth): 支持使用 Google OAuth 登录

  • 示例 2 — 新功能（不带 scope）
    feat: 添加用户导出为 CSV 的功能

  • 示例 2 — 修复
    fix(ui): 修复深色模式下按钮文字不可见

  • 示例 3 — 破坏性变更
    feat(api)!: 移除 v1/user 接口，改为 v2/users

  • 示例 4 — 文档更新
    docs: 补充 README 中的部署步骤

  • 示例 5 — 维护类（不影响发布）
    chore(deps): 升级 eslint 到 8.0.0

  • 示例 6 — 样式/格式（不影响功能）
    style: 统一代码格式为 Prettier 配置

  • 示例 7 — 性能优化
    perf(db): 优化查询索引以减少 95% 响应延迟

  • 示例 8 — 测试相关
    test: 增加用户登录相关的单元测试用例

6. 等待审核结果 ​

这时作为社区的一个 contributor，您已经提交完毕。

  • 等待门禁结果：如果您提交的是代码，系统一般会自动进行一系列门禁检查，例如 codecheck 等，以确保修改可用。
  • 等待review：如果代码通过门禁，审核人对提交代码没有异议，社区 maintainer 或 committer 会进行/lgtm动作。
  • 最后确认：如果一切顺利，社区 maintainer 或 committer 会进行/approve动作。
  • 认可贡献：以上完成后，您的代码/文档会被合并到上游仓库，表示已被认可。

其他经验 ​

1. Watch（关注） ​

当你关注（Watch）一个项目时，你会收到关于项目的更新和动态的通知。这包括项目的问题、合并请求、新发布的版本等。这对于希望及时了解项目进展的人很有帮助。

2. Star（点赞） ​

点赞（Star）一个项目表示你对这个项目感兴趣或者支持它；点赞也可作为浏览他人仓库时的记号，让你可以稍后再找到感兴趣的项目。

experience13

点亮即为成功。

结语 ​

通过这次openFuyao开源社区的入门经验，我学到了很多关于开源贡献的知识。从注册账号到提交PR，每一步都是我成长的一部分。我希望我的经验能够帮助更多的新手加入到这个充满激情和创造力的开源世界中来。让我们一起为开源社区贡献自己的力量吧！

本文由openFuyao社区首发，欢迎遵照CC-BY-SA 4.0协议规定转载。