openJiuwen 提交信息规范实战9 种 Conventional Commits 类型让代码顺利合入【免费下载链接】communityopenJiuwen community承载社区章程、社区规范、CLA签署等社区运作类相关信息项目地址: https://gitcode.com/openJiuwen/communityopenJiuwen 是开源 AI Agent 平台向社区贡献代码前你需要掌握它的提交信息规范。openJiuwen 采用Conventional Commits约定式提交标准定义了feat、fix、docs等9 种提交类型规范的提交信息能让 PR 评审更快、变更日志自动生成是代码顺利合入的第一步。本文带你快速上手这套规范。完整规范可参考官方贡献指南README_CN.md 与 CONTRIBUTING_zh.md 中的「提交信息规范」章节。一、提交信息的基本格式type(scope): subjectopenJiuwen 要求所有提交信息遵循统一的三段式格式type(scope): subjecttype类型必填说明这次提交「干了什么」共 9 种取值scope范围可选用括号注明影响范围如model、agent、workflowsubject主题一句话描述变更内容必须使用英文。两个容易踩坑的要求提交信息一律用英文哪怕项目文档是中文提交前建议用git rebase把多次零散提交合并为一个原子性提交保证主干历史清晰可追溯。二、9 种提交类型速查表feat 到 chore 一次讲清下面这张表覆盖了 openJiuwen 允许的全部 9 种类型建议截图保存类型含义典型场景feat新功能新增用户认证模块fix错误修复修复按钮点击事件失效docs仅文档更改更新贡献指南style不影响代码含义的更改调整空格、代码格式refactor重构非修 bug、非加功能简化组件结构perf性能优化优化运行时性能test测试相关补充接口单元测试ciCI 配置与脚本变更配置 CI 流水线chore构建过程/辅助工具变更升级依赖版本官方给出的完整示例见 README_CN.mdfeat(model): add user authentication module fix(front): resolve button click event issue docs(guide): update contribution guidelines style(agent): adjust code formatting to match style guide refactor(workflow): simplify component structure perf(runtime): optimize runtime performance test(endpoint): add unit tests for API endpoints ci: configure GitCode CI pipeline chore: update dependencies to latest versions新手最容易混淆的三组featvsfix加了新能力用feat修了已有缺陷用fixrefactorvsstyle改变代码结构但不改行为是refactor只动空格/缩进/格式是styleperfvsfeat性能优化不改变功能表现时用perf别误写成新功能。三、一次看懂 PR 中的提交记录提交信息最终会展示在 PR 页面评审人一眼就能看懂你的改动脉络。下面这条 PR 包含 3 条 commit每条 commit 的作者邮箱都会被用于 CLA 签署校验 一个 PR 中所有 commit 的作者邮箱都必须已签署 CLAPR 才能通过检查。提交前请先确认邮箱无误参考 cla指导.md。四、复杂提交怎么写正文 空行 Refs简单变更一行就够涉及功能较多时使用多行格式——首行保持type(scope): subject空一行后写正文说明最后关联 Issuefeat(core): add configuration management feature Add configuration management module to support dynamic settings loading. This feature includes: - Configuration file parser - Environment variable support - Settings validation logic Refs: #12345格式要点参考 CONTRIBUTING_zh.md首行即完整类型信息评审列表页只显示这一行首行与正文之间必须空一行正文用短句 列表写清「做了什么、包含哪些部分」末尾用Refs: #12关联 Issue 编号方便追溯。五、从本地提交到 PR 合入的完整流程规范写完只是开始把提交正确送出去同样重要。核心步骤如下1. 本地提交带上 signoff 邮箱git add . git commit -sm feat: xxx # -s 会自动附加 signoff 邮箱提交用的邮箱必须与你签署 CLA 的邮箱一致。如果通过平台页面提交可在账号设置页的「电子邮件」中查看可用邮箱2. 推送并创建 PRgit push -f origin myfeature然后访问 Fork 仓库页面点击创建 Pull Request选择功能分支生成 PR。3. PR 描述要写全PR 描述建议包含变更的目的与背景、变更详细说明、测试情况、相关 Issue 编号#I12345格式。4. 关联 Issue 触发门禁创建 Issue 后在 PR 描述框输入#I 五位 Issue ID 完成关联CI 门禁执行完成会自动在关联 PR 中评论结果。评审需满足达到最低评审人数、评审问题全部解决、禁止合入自己创建的 PR、流水线检查全部通过。5. 提交邮箱填错了重置 commit 重来如果 commit 作者邮箱设置错误git 方式提交的 PR 只需重置即可N 条 commit 合成 1 条git reset --soft HEAD~N # N 为需要合并的 commit 数量 git add . git commit -m feat: xxx # 提交信息重新按规范书写 git push -f详细操作见 cla指导.md。六、新手常见错误清单4 个细节决定合入速度❌ 用中文写提交信息 → ✅ 一律英文如feat(agent): add memory module❌ 把格式调整写成新功能 → ✅ 空格/缩进类改动用style❌ 攒了一堆碎片提交直接推上去 → ✅ 用git rebase合并为原子提交❌ 提交邮箱没签 CLA → ✅ 提交前核对邮箱避免 PR 卡在 CLA 检查。总结记住这一句就能覆盖 80% 的场景type(scope): subject英文书写9 种类型对号入座复杂变更用多行格式并 Refs 关联 Issue。把提交信息写好等于给评审人递上了一张「快速放行」的通行证。openJiuwen 社区同时欢迎文档、合规与安全类非代码贡献更多参与方式可浏览社区资料贡献指南 README_CN.md、CLA 使用指南、社区章程。祝你的第一个 PR 顺利合入 【免费下载链接】communityopenJiuwen community承载社区章程、社区规范、CLA签署等社区运作类相关信息项目地址: https://gitcode.com/openJiuwen/community创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
