企业官网建设流程全解析

如何为REDox贡献代码:源码构建、一致性测试套件与社区指南

【免费下载链接】REDoxHigh-performance, token-based structured data engine for .NET. A core component of REX, the technology behind CAPCOM's next-generation game engine.项目地址: https://gitcode.com/gh_mirrors/redox/REDox

REDox 贡献代码从这里开始！REDox（RE:Dox）是卡普空（CAPCOM）为下一代游戏引擎 "REX" 技术打造的 .NET 高性能结构化数据引擎，也是本文的核心——REDox 贡献指南。无论你是想修复 Bug、提出功能建议，还是跑通它的构建与测试，这篇完整指南都能帮你快速上手。

REDox 是什么：一分钟了解贡献对象

REDox 把 JSON、JSON5、CBOR、MessagePack、TOML、XML、HTML、CSV、INI、DOX 等格式统一解析成紧凑的64 位 token DOM/IR，再基于它完成读写、序列化与自动并行反序列化。

JSON / JSON5 / CBOR / MessagePack / TOML / XML / HTML / CSV / INI / DOX ↓ Compact token DOM / IR ↓ Reader / Writer / Serializer / Deserializer

• 核心源码位于 src/REDox/，含 DToken.cs、Document.cs 等 token 引擎实现
• 各格式组件（CBOR、TOML、XML 等）按项目拆分在 src/ 下
• 基准测试数据（如canada.json）对比见 README.md

💡 贡献前先花 10 分钟通读 README.md，理解"一个 token 结构 = 源数据视图 + 可编辑 DOM"这一核心设计，写 PR 会事半功倍。

贡献的 3 种途径：先 Issue 后代码

根据 CONTRIBUTING.md，官方欢迎三类参与：

关于代码提交（Pull Request）：官方说明会对你提交的 Bug 报告和建议进行**分诊（triage）**并推进实现，详见 CONTRIBUTING.md#L38-L42。所以最稳妥的贡献路径是：先提交高质量 Issue，再跟进代码实现。

环境准备：REDox 源码构建最快方法

REDox 要求.NET 10 或更高版本SDK。

一键安装：带子模块克隆仓库

⚠️ 关键点：测试与基准数据（simdjson-data、JSONTestSuite、json5-tests、toml-test）以git 子模块形式存放在external/目录下，克隆时必须带上子模块，否则一致性测试无数据可用。

git clone --recurse-submodules https://gitcode.com/gh_mirrors/redox/REDox cd REDox

子模块定义见 .gitmodules，对应external/下的 4 个数据仓库：

• external/simdjson-data— 基准测试数据集
• external/JSONTestSuite— JSON 一致性测试
• external/json5-tests— JSON5 一致性测试
• external/toml-test— TOML 一致性测试

如果已经克隆过但忘了加子模块参数，补一句即可：

git submodule update --init --recursive

源码构建步骤：3 条命令跑通

整个解决方案是 REDox.slnx，涵盖src/下 12 个库项目、11 个测试项目和 5 个基准项目。

# 1. 构建（Release 配置） dotnet build REDox.slnx -c Release # 2. 运行全部测试 dotnet test REDox.slnx -c Release # 3. 运行基准测试（必须 Release） dotnet run -c Release --project benchmarks/REDox.Json.Benchmarks

构建排错速查

测试统一使用 xUnit v3 框架，版本与目标框架在 tests/Directory.Build.props 中集中管理。

一致性测试套件：REDox 最硬核的贡献保障

REDox 的一致性测试（conformance tests）直接消费子模块中的业界标准测试用例，这是它区别于普通序列化库的地方：

• JSON：external/JSONTestSuite中的边界用例由 JsonParseTests.cs 等用例覆盖
• JSON5：Json5ParseTest.cs 读取json5-tests子模块的目录逐条执行，目录缺失会直接报错提示
• TOML：toml-test用例驱动 tests/REDox.Toml.Tests/
• 兼容层：tests/REDox.Serialization.SystemTextJson.Tests/、tests/REDox.Serialization.NewtonsoftJson.Tests/ 等验证与主流序列化库的行为一致

🔍 修改解析器时的建议：先跑dotnet test全量验证，再重点看你改动对应的格式测试项目（如 tests/REDox.Cbor.Tests/），确保没有破坏标准用例。

基准数据怎么接进来的

基准测试用 BenchmarkDotNet 的DataSource特性直接指向子模块文件，例如 Canada.cs 声明[DataSource("external/simdjson-data/jsonexamples/canada.json")]。新增基准数据集时，照此模式添加一个 DataSource 声明即可。

代码风格：项目自带清理脚本

项目提供了 scripts/cleanupcode.sh（Windows 版为 scripts/cleanupcode.bat），基于 JetBrains ReSharper 的jb cleanupcode统一格式化整个解决方案。它会自动检测并安装JetBrains.ReSharper.GlobalTools，提交前跑一遍能显著减少评审时的格式噪音。

社区规范与安全问题上报

• 行为准则：所有参与者需遵守 CODE_OF_CONDUCT.md，语言不限，但使用英语或日语沟通更顺畅
• 安全漏洞：请私下通过邮件td_oss_support@capcom.com上报，流程见 SECURITY.md
• 许可协议：项目采用 Apache-2.0 许可（见 LICENSE）
• 项目状态：RE:Dox 仍在积极开发中，API 与预览格式支持可能随版本演进，贡献前留意这一点

贡献清单：提交前自查 5 项

1. ✅ 本地dotnet build REDox.slnx -c Release通过
2. ✅dotnet test REDox.slnx -c Release全部通过（含一致性测试）
3. ✅ Issue 中已描述动机与复现/验证方式
4. ✅ 跑过 cleanupcode 脚本，格式统一
5. ✅ 涉及性能宣称时，附带-c Release基准数据

按照这份 REDox 贡献指南，你已具备从克隆、构建、测试到规范沟通的完整能力——选择你关心的格式组件或解析器模块，从一个小 Issue 开始你的第一次贡献吧！🚀

【免费下载链接】REDoxHigh-performance, token-based structured data engine for .NET. A core component of REX, the technology behind CAPCOM's next-generation game engine.项目地址: https://gitcode.com/gh_mirrors/redox/REDox