TensorRT开源项目代码贡献规范详解

TensorRT开源项目代码贡献规范详解

TensorRT NVIDIA® TensorRT™ 是一个用于在 NVIDIA GPU 上进行高性能深度学习推理的软件开发工具包（SDK）。此代码库包含了 TensorRT 的开源组件 项目地址: https://gitcode.com/gh_mirrors/tens/TensorRT

前言

TensorRT作为NVIDIA推出的高性能深度学习推理引擎，其开源项目吸引了众多开发者的关注和参与。本文将深入解析TensorRT开源项目的代码贡献规范，帮助开发者理解如何高效、规范地为项目做出贡献。

问题跟踪与需求管理

在TensorRT项目中，任何功能增强、错误修复或变更请求都必须从创建问题请求开始。这一流程确保了变更的透明性和可追溯性。TensorRT工程师会对每个问题请求进行评审，只有获得批准的请求才能进入代码评审阶段。

代码规范要求

1. 代码风格一致性

TensorRT项目对代码风格有严格要求，所有贡献的源代码必须遵循项目制定的编码指南。这包括但不限于：

• 类、函数/方法和变量/字段的命名规范
• 注释风格统一
• 一致的缩进方式
• 合理的行长度控制

项目使用clang-format工具来强制执行代码格式化规则，开发者应在提交代码前运行格式化命令：

# 格式化暂存的更改
git-clang-format --style file

# 格式化单个源文件
clang-format -style=file -i -fallback-style=none <文件名>

2. 代码质量保障

为了保持代码的高质量，贡献者需要注意：

• 避免引入不必要的复杂性，保持代码的可维护性和可读性
• 每个提交应专注于解决单一问题，复杂的变更应拆分为多个提交
• 确保构建日志干净，不包含任何警告或错误
• 所有示例测试(sample_*)必须通过

3. 提交信息规范

提交信息需要遵循特定格式：

#问题编号 - 提交标题

提交正文

标题应使用命令式语气，正文详细说明变更内容。这种格式有助于维护清晰的变更历史。

测试与文档要求

1. 测试覆盖率

所有开源组件必须包含相应的测试：

• 新引入的组件（如插件）需要提供测试示例验证功能
• 现有功能的修改需要确保不破坏现有测试用例

2. 文档完整性

每个开源组件必须附带文档（README），内容包括：

• 功能描述
• 依赖关系说明
• 已知问题列表

可以参考现有示例和插件的README.md文件作为模板。

功能添加与修改规范

当需要添加或禁用功能时，应遵循以下原则：

1. 添加CMake选项，默认值应与现有行为匹配
2. 对于可以基于选项值完全包含/排除的文件，应修改CMakeLists.txt而非使用#ifdef保护整个文件
3. 对于现有文件的微小修改，可以使用#ifdef保护相关代码块

开发者工作流程

1. 代码变更流程

1. 开发者创建个人分支进行开发
2. 将变更推送到个人分支
3. 准备就绪后，创建合并请求将分支变更合并到上游选定分支

注意事项：

• 谨慎选择源分支和目标分支
• 版本化发布的TensorRT OSS位于release/分支
• 在评审期间，应在PR标题前添加[WIP]标记

2. 代码评审过程

目前项目尚未建立CI/CD流程，因此：

• 开发者需要自行完成充分测试
• 至少需要一位TensorRT工程师进行代码评审
• 只有通过测试和评审的PR才会被接受

开发者证书签署要求

TensorRT要求所有贡献者签署其提交，以确认贡献是原创作品或有权在相同或兼容许可证下提交。

签署方式

在提交时使用-s选项：

git commit -s -m "提交信息"

这将在提交信息中添加签名行：

Signed-off-by: 姓名 <邮箱>

开发者证书内容

签署意味着贡献者确认：

1. 贡献是原创作品或有合法提交权利
2. 基于他人工作的修改已获得适当授权
3. 理解贡献和相关信息将被公开并永久保存

结语

遵循TensorRT的贡献规范不仅能提高代码被接受的概率，也有助于维护项目的整体质量。开发者应特别注意代码风格一致性、测试覆盖率和文档完整性等方面。通过规范的贡献流程，我们可以共同推动TensorRT生态系统的发展和完善。

TensorRT NVIDIA® TensorRT™ 是一个用于在 NVIDIA GPU 上进行高性能深度学习推理的软件开发工具包（SDK）。此代码库包含了 TensorRT 的开源组件 项目地址: https://gitcode.com/gh_mirrors/tens/TensorRT