如何参与CodexHost贡献：Issue与PR规范、仓库自动化与社区支持完整指南

如何参与CodexHost贡献Issue与PR规范、仓库自动化与社区支持完整指南【免费下载链接】codex-hostRun Pi and Claude Code directly in Codex Desktop. 在 Codex Desktop 中直接运行 Pi 和 Claude Code。项目地址: https://gitcode.com/gh_mirrors/co/codex-hostCodexHost 贡献其实没有想象中那么难它是一个开源的桌面 Agent 宿主项目让你在 Codex Desktop 中直接运行 Pi、Claude Code 等十余种 Harness。无论你是想修复一个 Bug、补一段文档还是接入一个新 Harness只要遵循本文的 Issue 与 PR 规范、了解仓库自动化的行为边界就能快速上手贡献并提高合并效率。一、动笔之前先认识 CodexHost 的代码结构提交CodexHost 贡献前花十分钟了解仓库布局能帮你把改动放到正确的位置。项目由两部分组成详见 AGENTS.md目录语言职责crates/Rust原生启动、进程代理、更新安装、跨平台集成packages/TypeScript协议路由、Harness 适配器、本地控制台、Renderer 扩展scripts/release/JavaScript发布准备、打包与推送tools/JavaScript开发工具与各类技术 Gate以 Pi 为例一次请求的调用链是Desktop → 公共层 → Pi 插件 → 原生进程。理解这条链路有助于你判断一个 Bug 应该修在 Rust 侧还是 TypeScript 侧适合新手贡献的三类方向小而有界的 Bug 修复例如某平台路径处理、日志文案、控制台诊断页packages/console-server/问题文档完善docs/ 下有完整的中文/英文/韩文文档体系入口在 docs/index.md新增 Harness工作量较大建议先在 Issue 里讨论方向避免重复实现可以让编码 Agent 参考仓库内的codexhost-add-harnessSkill二、如何提交一个高质量 Issue新建 Issue 时可以选择Bug、Feature 或 Question表单也保留空白 Issue。关键原则是选对主要影响领域无法确定时选Other / Unknown不要把 Harness、Model、Provider 和 Account 混为一谈术语定义见 docs/project/领域术语表.md。Bug 报告建议包含CodexHost 版本、安装方式Codex Desktop 完整版本 / buildOS / 架构、Harness 名称与原生 CLI 版本本地 / SSH / Remote Control 运行模式预期行为、实际行为、最小复现步骤偶发问题写明观察条件相关的脱敏错误信息、日志或截图⚠️ 安全红线请勿上传 Token、Cookie、认证文件或未脱敏的私有项目内容安全漏洞不要公开披露尚未修复的攻击细节。暂时未知或不适用明确写出来即可。三、如何写出更容易被合并的 PR1. 准备本地开发环境环境要求官方 Codex Desktop、Node.js 22.19 或 24、Rust。git clone https://gitcode.com/gh_mirrors/co/codex-host cd codex-host npm ci npm startnpm start会从源码构建并启动macOS/Windows 会先停掉运行中的 Codex Desktop 进程。2. PR 标题与描述规范目标分支固定为main标题建议采用fix(scope): ...、feat(scope): ...、docs: ...等 Conventional Commit 格式标题格式还直接影响第四节的自动标签描述中说明目的、关联 Issue没有可写N/A、实现范围、实际执行过的验证——不要只写“测试通过”3. 遵循包边界与测试要求Rust 负责原生层不承载 Host 协议或 Harness 语义跨包依赖必须走包的公共导出改动依赖方向前先阅读 tools/check-boundaries.mjs按风险选择定向测试行为变更应有验证低风险的文档修改不要求机械地新增测试涉及 Desktop、Renderer 或真实 Harness 的改动分别记录自动测试与实机结果说明版本、平台和未验证部分UI 变化附脱敏截图4. 作者的持续责任提交 PR 后你需要理解自己的改动、回应反馈、补充验证并维护分支——维护者不会默认接管整个修复工作。四、仓库自动化会做什么以及不做什么CodexHost 的Repository maintenance自动化只做两件事边界非常克制完整说明见 docs/operations/repository-maintenance.md自动化行为说明明确标题自动标签fix:/feat:/docs:标题分别打bug/enhancement/documentation标题不明确则跳过不覆盖人工选择CI 完成后的简短评论当前提交的四平台 CI 全部结束后更新一条结果评论失败时附可识别、脱敏的原始错误日志它不会做的事不处理 Issue、不催补模板、不自动关闭/批准/合并 PR、不切换 Draft、不重复汇总 AI 审查。如果某个 PR 不希望被自动处理可以添加automation:ignore标签。自动化逻辑归属 packages/repository-automation/这是一个无第三方运行时依赖的 ESM 包可信工作流直接加载其index.mjs不打包进 Host 产品也不调用模型、不执行 PR 代码。五、常用验证命令速查提交前可参考 package.json 中的脚本自行组合命令作用npm run check格式 Lint 类型检查 TypeScript 全量测试 Rust 检查npm run lintESLint 包边界检查npm run test:typescript构建并运行完整 TypeScript 测试npm run test:rustRust 工作区测试 原则不要声称某项检查已通过而你其实没跑过跳过或受阻的检查要如实说明原因。六、社区支持遇到问题去哪里❓安装与使用问题项目维护微信群欢迎扫码加入交流见 README.md 的 Community 部分Bug 报告请务必开 Issue 而不是只在群里聊便于追踪与复现文档索引docs/index.md 按功能领域列出了全部文档包括各 Harness 专项、平台指南与维护手册️历史决策openspec/specs/ 下保留了各项能力的规格说明openspec/changes/archive/ 可追溯历次变更的 proposal、design 与 tasks参与贡献快速清单 ✅先读 CONTRIBUTING.md 与 AGENTS.mdIssue 写清版本、环境、复现步骤大功能先讨论方向PR 标题用 Conventional Commit描述写清目的、范围与实际验证遵守包边界按风险做定向测试关注自动评论的 CI 结果失败日志已脱敏可直接参考提交后及时回应反馈维护好自己的分支希望这份CodexHost 贡献指南能帮你迈出第一步——小而完整的修复同样很有价值欢迎一起把 Codex Desktop 变成最好的多 Agent 工作台。【免费下载链接】codex-hostRun Pi and Claude Code directly in Codex Desktop. 在 Codex Desktop 中直接运行 Pi 和 Claude Code。项目地址: https://gitcode.com/gh_mirrors/co/codex-host创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考