首页/新闻资讯/正文详情

openJiuwen 提交信息规范实战:9 种 Conventional Commits 类型让代码顺利合入

发布时间:2026/9/24 17:07:25 来源:云帆数科 栏目:资讯中心
openJiuwen 提交信息规范实战:9 种 Conventional Commits 类型让代码顺利合入
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),仅供参考

相关推荐

为什么大型XML文件解析要选StAX流式解析?xmlstream带来的终极解决方案
为什么大型XML文件解析要选StAX流式解析?xmlstream带来的终极解决方案

为什么大型XML文件解析要选StAX流式解析?xmlstream带来的终极解决方案 【免费下载链接】xml_stream 提供 XML 操作相关的 StAX 风格接口,符合 XML 1.0 规范,支持命名空间。 项目地址: https://gitcode.com/Cangjie-TPC/xml_stream xml… · 2026/9/24 17:07:25

YARA 模块系统完全指南:从官方模块详解到自定义模块开发
YARA 模块系统完全指南:从官方模块详解到自定义模块开发

网络安全模式匹配 【免费下载链接】yara The pattern matching swiss knife 项目地址: https://gitcode.com/gh_mirrors/ya/yara 点击查看 免费下载 YARA 的模块(Module)是其扩展机制的核心:通过 import 指令在规则中引入数据结构… · 2026/9/24 17:07:25

Microm:用JavaScript将浏览器麦克风转换为MP3的优雅解决方案
Microm:用JavaScript将浏览器麦克风转换为MP3的优雅解决方案

Microm:用JavaScript将浏览器麦克风转换为MP3的优雅解决方案 【免费下载链接】microm :musical_note: Beautiful library to convert browser microphone to mp3 in Javascript :musical_note: 项目地址: https://gitcode.com/gh_mirrors/mi/microm 项目介绍… · 2026/9/24 17:07:25

CRTP 编译期多态与静态接口:没有虚函数也能多态
CRTP 编译期多态与静态接口:没有虚函数也能多态

继承 + 虚函数不是 C++ 里实现「一套接口、多种实现」的唯一路子。如果你想要的是编译期就定下来的多态——没有运行期查虚表(virtual table,vtable)、调用能被内联(inline)、对象还更小——CRTP 就是这个需求的标准答案。这篇用真跑出来的 sizeof 和计数器实例,把 CRTP … · 2026/9/24 17:44:52

enum class 为什么优于裸 enum:作用域、类型安全与内存实测
enum class 为什么优于裸 enum:作用域、类型安全与内存实测

很多 C++ 初学者写枚举时随手就写 enum Color { red, green, blue };,编译器也不报错,于是就一直这么用。直到某天两个枚举的同名值撞了、或者一个本该是「颜色」的变量被悄悄当成整数参与运算,bug 藏得很深。C++11 引入的 enum class(枚举类,scoped enumeration)就是为解… · 2026/9/24 17:44:52

const 该放哪:从顶层 const 到 const 成员函数
const 该放哪:从顶层 const 到 const 成员函数

const 在 C++ 里不是「加个修饰」那么简单——放在 * 左边还是右边,含义完全不同;放在成员函数末尾,改的甚至是隐藏的 this 指针类型。搞混这两者,轻则编译报错,重则写出自以为只读、其实能改的接口。这篇把 const 的位置语义、它对函数签名和性能的影响,用代码和真实输出… · 2026/9/24 17:44:52

第032篇 面试必问·网易浏览器与渲染原理:浏览器缓存机制,强缓存与协商缓存如何配合(压箱底干货)
第032篇 面试必问·网易浏览器与渲染原理:浏览器缓存机制,强缓存与协商缓存如何配合(压箱底干货)

摘要:本篇复盘 网易 前端开发岗位在 浏览器与渲染原理 方向的真实问法,重点拆 8 道题:限流算法有哪些,各适合什么场景、浏览器缓存机制,强缓存与协商缓存如何配合、浏览器事件模型,事件委托有什么好处。每题按「考察点 → 参考答案 → 代码/实操 → 易错点 → 面试官追问… · 2026/9/24 17:44:52

enable_shared_from_this:类内部安全拿到 shared_ptr
enable_shared_from_this:类内部安全拿到 shared_ptr

在类的成员函数里,有时需要把「指向自己的 shared_ptr」交给别人——把自己注册进容器、挂到回调里、塞进观察者列表。最危险的写法是直接 std::shared_ptr<T>(this):它编译通过、看着能用,实则埋下 double free(重复释放) 的雷。这篇把雷挖出来,并给出正确解法 st… · 2026/9/24 17:44:52

Python教程-Python中的基本命令 | 魔术命令
Python教程-Python中的基本命令 | 魔术命令

关于在教程里面提到的那些基本命令, 还有魔术命令的具体用法介绍。当它在1991年首次引入的时候, 普遍认为是属于自负风险的类型的一种语言。但是现在的情况已经改变了, 它已经成为了一种主导性的语言, 并且被用于数据科学领域、机器学习领域以及软件开发领域。大家都清楚, 它是… · 2026/9/24 17:44:39

基于YOLOv8的渔船作业监控系统:从环境搭建到边缘部署全流程
基于YOLOv8的渔船作业监控系统:从环境搭建到边缘部署全流程

简介&#xff1a;这是一套面向计算机、人工智能、自动化等专业学生与教师的毕业设计级项目资源&#xff0c;围绕YOLOv8实现渔船作业监控系统&#xff0c;可用于毕设、课程设计、大作业或项目立项演示。压缩包共97个文件&#xff0c;约24.21MB&#xff0c;以70个Python源码文件为… · 2026/9/24 0:00:13

1D-CNN时间序列建模实战:从Conv1d原理到工业落地
1D-CNN时间序列建模实战:从Conv1d原理到工业落地

简介&#xff1a;面向时间序列数据建模的一维卷积神经网络完整实现&#xff0c;适合深度学习入门者及需要快速验证时序模型的研究者&#xff0c;能够从音频、文本、传感器或股价等序列中挖掘局部特征与时间依赖。压缩包体积很小&#xff0c;只有3KB&#xff0c;内含3个Python脚… · 2026/9/24 0:00:26

柔软的L:汉语语流中被忽视的舌肌张力控制
柔软的L:汉语语流中被忽视的舌肌张力控制

1. 这个“L”不是字母表里的L&#xff0c;而是舌尖上的L最近在几个方言群和语音教学社群里&#xff0c;反复看到有人发一句&#xff1a;“也说字母L&#xff1a;柔软的长舌”。初看以为是英语发音课笔记&#xff0c;点开才发现全是方言爱好者、播音系学生、语言康复师甚至戏曲演… · 2026/9/24 0:00:44

了解更多?预约专属演示

我们的顾问将为您一对一讲解产品与方案

企业微信二维码