第41周：开源项目深度参与

字数统计: 2.6k字   |   阅读时长≈ 11分

第41周：开源项目深度参与

目标：从理论走向实践——真正参与开源项目（DPDK/Cilium/Envoy 等），了解开源协作流程，提交至少一个被合并的补丁。

1. 开源协作基础

1.1 Git 与 GitHub/GitLab 工作流

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
开源项目典型工作流：

  ┌─────────────────────────────────────────────┐
  │  1. Fork 主仓库                                │
  │     GitHub/Gitee: Fork 按钮                    │
  │     git clone <你的 fork>                      │
  │  2. 添加上游                                   │
  │     git remote add upstream <主仓库>            │
  │  3. 创建特性分支                               │
  │     git checkout -b feature/my-fix            │
  │  4. 编码 + 测试                                 │
  │  5. 提交                                       │
  │     git commit -s（签名）                       │
  │  6. 推送到 fork                                 │
  │     git push origin feature/my-fix             │
  │  7. 创建 Pull Request                          │
  │  8. 与维护者讨论 + 修改                         │
  │  9. CI 通过 → squash merge                      │
  └─────────────────────────────────────────────┘

1.2 提交规范

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Linux 内核风格（很多网络项目使用）：

  <type>(<scope>): <subject>
  <空行>
  <body>
  <空行>
  <footer>

  type:  feat, fix, docs, refactor, test, build, ci
  scope: 影响的范围

  示例：
  feat(net): add support for XDP redirect map

  This patch adds support for redirecting XDP packets
  to a CPUMAP, allowing load balancing across multiple
  CPU cores.

  Signed-off-by: Your Name <email@example.com>

1.3 Signed-off-by（开发者原创声明）

1
2
3
4
5
6
7
8
9
10
11
12
13
# 配置全局
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

# 提交时自动签名
git commit -s -m "fix: resolve buffer overflow in parser"
# 输出：
# fix: resolve buffer overflow in parser
#
# Signed-off-by: Your Name <email@example.com>

# 手动添加
git commit --amend --signoff

2. 选择项目

2.1 推荐项目（按难度）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
入门（适合第一次贡献）：
  - DPDK 示例代码注释 / 文档改进
  - Cilium 文档修正
  - Envoy 翻译贡献
  - Linux kernel 文档

中级（适合有 C 经验）：
  - DPDK bug fix（小问题）
  - Cilium BPF helper 改进
  - Envoy filter 测试用例
  - bpf/libbpf 工具

高级（适合熟练者）：
  - DPDK 新驱动
  - Cilium 新功能
  - Envoy 新 filter
  - Linux 内核子系统

2.2 找合适的 Issue

1
2
3
4
5
6
7
8
9
10
11
12
13
# === GitHub / Gitee 找 good first issue ===

# DPDK:
# https://github.com/DPDK/dpdk/issues?q=label%3A%22good+first+issue%22

# Cilium:
# https://github.com/cilium/cilium/issues?q=label%3A%22good+first+issue%22

# Envoy:
# https://github.com/envoyproxy/envoy/issues?q=label%3A%22good+first+issue%22

# Linux kernel:
# https://github.com/torvalds/linux/issues?q=label%3A%22good+first+issue%22

2.3 Issue 选择策略

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
筛选 Issue 的标准：

✅ 好的 first issue：
  - 明确的小 bug fix
  - 文档 / 注释改进
  - 单文件修改
  - 不需要深入了解整个架构
  - 有清晰的问题描述和复现步骤

❌ 不适合 first issue：
  - 性能优化（需要基准测试）
  - 新功能（需要设计）
  - 跨多个子系统
  - 缺少复现步骤
  - 维护者已 6 个月没活动

3. DPDK 贡献指南

3.1 仓库结构

1
2
3
4
5
6
7
8
9
10
11
12
13
DPDK 仓库（git.dpdk.org / github.com/DPDK/dpdk）：

  app/                  # 示例应用
  lib/                  # 核心库
  drivers/net/          # 网卡驱动
  drivers/bus/          # 总线驱动
  kernel/               # 内核模块
  doc/                  # 文档
  examples/             # 新示例代码
  tools/                # 工具
  MAINTAINERS          # 维护者列表
  CONTRIBUTING         # 贡献指南
  LICENSE

3.2 DPDK 编码规范

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// === DPDK 编码风格（参考 Linux 内核）===

// 1. 缩进：tab
// 2. 行长度：< 80 字符
// 3. 函数命名：snake_case
// 4. 宏：全大写
// 5. 类型：snake_case_t

// 函数注释
/**
 * Initialize a port.
 *
 * @param port
 *   The port identifier.
 * @param nb_rx_queues
 *   Number of receive queues.
 * @param nb_tx_queues
 *   Number of transmit queues.
 * @param port_conf
 *   Pointer to the port configuration structure.
 *
 * @return
 *   0 on success, negative errno value on failure.
 */
int rte_eth_dev_configure(uint16_t port, uint16_t nb_rx_queues,
                          uint16_t nb_tx_queues,
                          const struct rte_eth_conf *port_conf);

// 变量
int ret;  // 返回值
uint16_t port_id;

// 函数
static inline void foo(void);

// 宏
#define MAX_NUM 16

3.3 提交前检查

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# === DPDK 提交流程 ===

# 1. 克隆主仓库
git clone https://github.com/DPDK/dpdk.git
cd dpdk

# 2. 添加自己的 fork
git remote add origin https://github.com/<你的用户名>/dpdk.git

# 3. 创建分支
git checkout -b fix/some-issue

# 4. 修改代码

# 5. 验证编译
meson setup build
ninja -C build

# 6. 检查 patch 格式
./devtools/check-format-strings.sh
./devtools/check-git-log.sh
./devtools/check-spdx-tags.sh
./devtools/get-maintainer.sh < patch_file

3.4 创建 PR

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
PR 标题示例：
  [v21.11] net/i40e: fix RSS hash for fragmented packets

PR 描述模板：
  ## Description
  <描述问题>

  ## Fix
  <描述修复方法>

  ## Testing
  <如何测试>

  ## Depends-on
  <相关 PR>

4. Cilium 贡献指南

4.1 仓库结构

1
2
3
4
5
6
7
8
9
10
11
12
Cilium 仓库：
  bpf/                    # BPF 程序
  pkg/                    # Go 包
    datapath/             # 数据路径
    api/                  # API 定义
    envoy/                # Envoy 集成
  daemon/                 # 主程序
  operator/               # K8s operator
  test/                   # 测试
  Documentation/          # 文档
  CODEOWNERS             # 维护者
  CONTRIBUTING.md

4.2 编译与测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# === Cilium 开发环境 ===

# 1. 安装依赖
sudo apt install -y \
    build-essential \
    go-1.21 \
    docker.io \
    kubectl \
    minikube \
    kind

# 2. 克隆仓库
git clone --recurse-submodules https://github.com/cilium/cilium.git
cd cilium

# 3. 编译
make

# 4. 单元测试
make tests

# 5. 集成测试（需要 K8s 集群）
cd test/
./vagrant.sh start
./test.sh

4.3 常见贡献类型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Cilium 常见贡献：

1. 文档（最容易入门）：
   - Documentation/*.rst
   - examples/ 中的注释
   - README 更新

2. Bug 修复：
   - bug label issue
   - 复现 + 修复 + 测试

3. 功能增强：
   - BPF 程序新功能
   - 新增 metric
   - 新增 CRD 字段

4. 性能优化：
   - BPF 程序简化
   - 锁优化
   - 内存优化

5. Envoy 贡献指南

5.1 仓库结构

1
2
3
4
5
6
7
8
9
10
11
12
13
Envoy 仓库：
  source/                 # C++ 源码
    common/               # 通用代码
    extensions/           # 扩展
      filters/            # 过滤器
    server/               # 服务器
  api/                    # API 定义（proto）
  test/                   # 测试
  docs/                   # 文档
  contrib/                # 贡献代码
  api/                    # 公共 API
  VERSION
  REVIEWERS.md

5.2 贡献流程

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 1. 克隆
git clone https://github.com/envoyproxy/envoy.git
cd envoy

# 2. 设置开发环境
./ci/run_envoy_docker.sh './ci/do_ci.sh bazel.compile_time_options'

# 3. 单元测试
./ci/run_envoy_docker.sh './ci/do_ci.sh bazel.test //test/...'

# 4. 格式化
./tools/code_format/check_format.py fix

# 5. 提交流程
git checkout -b feature/my-feature
# 修改代码
./ci/run_envoy_docker.sh './ci/do_ci.sh bazel.test //test/...'
git commit -s -m "..."
git push origin HEAD
# 创建 PR

5.3 Envoy 贡献规范

1
2
3
4
5
6
7
8
9
10
11
12
13
代码风格（强制）：
  - C++17
  - clang-format
  - 一行 < 100 字符
  - 命名空间强制（不能污染全局）
  - 测试覆盖率 > 80%

提交规范：
  - 标题：[category] description
  - body: 详细说明
  - risk: low/medium/high
  - testing: 单元/集成/手动
  - docs: 是否需要文档更新

6. Linux 内核贡献

6.1 贡献方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Linux 内核贡献路径：

1. 内核源代码（drivers/net/...）
   - 直接发送给 maintainer
   - 高级但要求高

2. 通过 staging 树
   - staging 树是新手入门
   - 维护者更宽容

3. 文档（Documentation/...）
   - 适合新人
   - 编译 + 检查简单

4. 工具（tools/...）
   - selftests
   - perf 工具

6.2 内核提交规范

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# === 内核 patch 流程 ===

# 1. 配置 git
git config --global user.name "Your Name"
git config --global user.email "your@email.com"

# 2. 安装依赖
sudo apt install libssl-dev libncurses-dev flex bison \
    libelf-dev bc dwarves

# 3. 获取源码
git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
cd linux
git checkout v6.8  # 稳定版本

# 4. 配置
make menuconfig

# 5. 编译
make -j$(nproc) bzImage modules

# 6. 创建 patch
# 修改代码后
git add <files>
git commit -s  # 重要：用 -s 签名
git format-patch -1  # 生成 patch 文件

# 7. 验证
./scripts/checkpatch.pl 0001-my-fix.patch

# 8. 发送给维护者
# 找到 MAINTAINERS 文件中的 NETDEV 相关人
git send-email --to <maintainer> <patch_file>

6.3 内核代码风格

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Linux 内核编码规范
// Documentation/process/coding-style.rst

1. 缩进：tab（8 字符）
2. 行长度：< 80 字符（推荐）
3. 命名：snake_case
4. 大括号：
   if (x) {
       foo();
   } else {
       bar();
   }
5. 函数 < 100 行（建议）
6. 文件 < 2000 行（建议）
7. switch 必须有 default（即使空）

7. 实战：提交你的第一个 Patch

7.1 完整流程示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# === 1. 选择项目：修复一个文档错误 ===

# Issue：DPDK 文档中某处链接错误
# 标题：doc: fix broken link in xxx.rst

# === 2. Fork + 克隆 ===
git clone https://github.com/<你的用户名>/dpdk.git
cd dpdk
git remote add upstream https://github.com/DPDK/dpdk.git

# === 3. 同步最新代码 ===
git fetch upstream
git checkout main
git merge upstream/main

# === 4. 创建分支 ===
git checkout -b doc/fix-broken-link

# === 5. 修改文件 ===
# 编辑 doc/guides/prog_guide/...

# === 6. 验证 ===
# 重新构建文档
make -C build doc
# 检查格式
./devtools/check-git-log.sh

# === 7. 提交 ===
git add doc/guides/prog_guide/xxx.rst
git commit -s

# 编辑 commit message
# doc: fix broken link in xxx guide
#
# The link to <old> was broken because the file was moved to <new>.
# Update to the correct path.
#
# Signed-off-by: Your Name <email@example.com>

# === 8. 推送 ===
git push origin doc/fix-broken-link

# === 9. 创建 PR ===
# 在 GitHub 上点击 "Compare & pull request"
# 填写模板：
# ## Description
# Fix broken link in xxx guide
#
# ## Testing
# Build docs locally and verified all links work
#
# Closes #1234

# === 10. 等待 review ===
# 维护者会评论
# 根据反馈修改
# CI 通过后合并

7.2 常见反馈类型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Reviewer 反馈：

1. Nit（琐碎）：
   - 拼写错误
   - 风格问题
   - 注释改进

2. Style：
   - 命名约定
   - 函数分解
   - 添加注释

3. Logic：
   - 边界条件
   - 错误处理
   - 性能考虑

4. Design：
   - API 设计
   - 架构问题
   - 影响范围

5. Test：
   - 缺少测试用例
   - 边界情况
   - 文档

7.3 沟通技巧

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
有效的 PR 沟通：

1. 主动：
   - 写好 commit message
   - 添加测试
   - 更新文档

2. 谦逊：
   - "I see your point, let me fix"
   - "Good catch, will update"
   - 不用："I disagree" → "Let me think about this"

3. 解释：
   - "This is because..."
   - 提供数据支持
   - 引用相关代码

4. 耐心：
   - 维护者很忙
   - 等待 1-2 周是正常的
   - 可以友好 ping

5. 接受拒绝：
   - 不是每个 PR 都会被接受
   - 学习反馈
   - 下次更好

8. 持续贡献

8.1 建立声誉

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
开源贡献路径：

第一次（1 个月）：
  - 文档修正
  - 简单 bug fix
  - 学习流程

第二、三次（3 个月）：
  - 复杂 bug fix
  - 性能优化
  - 小功能

持续贡献（6+ 个月）：
  - 成为某个子系统的常驻贡献者
  - 被邀请 review 他人 PR
  - 可能在 Maintainer 文件中被列出

最终目标（1+ 年）：
  - 被提名为 Maintainer
  - 有权合并 PR
  - 在社区有一定影响力

8.2 简历/面试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
开源贡献的简历价值：

1. 证明能力：
   - 真实代码被专业开发者 review
   - 解决过实际问题
   - 了解大型项目协作

2. 行业认可：
   - HR 重视 GitHub profile
   - Maintainer 身份加分
   - 在圈内建立人脉

3. 面试加成：
   - 可作为技术深度证明
   - 讨论时引用自己 PR
   - 展示持续学习能力

8.3 推荐 PR 类型（目标：1+ 个合并）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
1. 文档（最容易）：
   - 拼写错误
   - 链接修复
   - 改进示例

2. 小型 bug fix：
   - 内存泄漏
   - 错误处理缺失
   - 边界条件

3. 测试改进：
   - 缺少的测试用例
   - 改进测试覆盖率

4. 性能改进：
   - 减少内存分配
   - 优化算法

5. 工具改进：
   - 新的 helper 函数
   - 改进的诊断工具

9. 时间安排建议

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
第 1 周：选择项目和 Issue
  - 浏览 3-5 个项目
  - 选择合适的 good first issue
  - 熟悉项目代码

第 2 周：搭建开发环境
  - 配置编译环境
  - 成功构建项目
  - 运行测试

第 3 周：编写和测试
  - 编写修复代码
  - 添加测试
  - 验证

第 4 周：提交和 Review
  - 提交 PR
  - 回应 review
  - 合并完成
赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia-plus根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

主要涉及技术：
Java后端开发、Linux开发、
公众号开发、开源爱好者、Linux

联系QQ:562054870