用途:这是 IdeaVim 项目的 Git 工作流约定,用于规范分支、提交、拉取请求(PR)与 CI 流程,适合在创建提交、管理分支、发起 PR、审查 Git 变更时参考。
分支:master 为主干,必须始终处于“可发布”状态;开发工作使用功能分支,命名格式为 VIM-XXXX/short-description(如 VIM-3948/editor);应频繁 rebase 到 master 以避免大量冲突;小型隔离改动(缺陷修复、细微调整)可直接提交到 master;未完成的改动只有在不破坏功能时才可提交到 master;集成使用 rebase 而非 merge commit,以保持线性历史。
提交:标准格式为“VIM-XXXX 变更描述”,与工单相关时以 YouTrack 工单 ID 开头,例如 VIM-3948 Traverse vertical panes in ConfigurableEditor;自动关闭格式为“fix(VIM-XXXX): 修复描述”,会将 YouTrack 工单移至“Ready To Release”。内容规则:每个提交必须只包含单一、聚焦且有意义的变更;不得包含无关改动(格式化、无关重构);行为变更需附带相应测试。
拉取请求:PR 目标为 master;CI 自动运行标准测试,命令为 ./gradlew test -x :tests:property-tests:test -x :tests:long-running-tests:test;外部贡献者的 PR 会列在变更日志的“Merged PRs”下。
问题跟踪:使用 YouTrack(而非 GitHub Issues),工单编号为 VIM-XXXX,地址为 https://youtrack.jetbrains.com/issues/VIM。
限制:以上为项目约定,具体执行细节与工具配置暂未提供。