如何为 vim-dogrun 贡献代码从提交 PR 到通过 CI 的完整流程【免费下载链接】vim-dogrun:dog: A dark Neovim / Vim colorscheme for the GUI and 256 / true-color terminals.项目地址: https://gitcode.com/gh_mirrors/vi/vim-dogrun想为vim-dogrun 贡献代码却不知从何下手这篇面向新手的完整贡献指南将带你走通从克隆仓库、修改 Rust 源码、生成配色文件到提交 PR 并通过 CI 检查的全流程。vim-dogrun 是一款支持 GUI、256 色与 true-color 终端的深色 Neovim / Vim 配色方案它的特别之处在于所有配色文件都由一个 Rust 生成器产出理解这套架构后你的贡献会变得又快又稳。为什么值得为 vim-dogrun 贡献代码先认识这个项目vim-dogrun 不是一份手写的.vim文件而是一个生成器 产物的双层架构源码你来改的部分Rust 生成器位于 generator/核心是 highlight.rs全部高亮组定义和 conv.rsHex → LAB → 256 色的转换工具。产物不要手改的部分colors/dogrun.vim、autoload/lightline/colorscheme/dogrun.vim、autoload/clap/themes/dogrun.vim等全部由生成器自动写出。项目内置了 50 插件的主题适配并支持 nvim-treesitter、LSP Semantic 高亮。下面是它在 Neovim 和 Vim 中的实际效果 黄金规则永远不要直接编辑生成文件。修改 Rust 源码后重新生成再提交生成结果这是让 CI 通过的关键前提。第一步克隆仓库并搭建本地环境把仓库克隆到本地git clone https://gitcode.com/gh_mirrors/vi/vim-dogrun cd vim-dogrun生成器依赖 Rust 工具链建议用项目自带的 mise.toml 统一管理just任务执行器和bacon热重载工具cd generator mise install如果还没有安装 mise 或 Rust请先安装对应工具链rustup 安装 stable 版本即可。第二步掌握生成器的三个核心文件开工前花两分钟认识 generator/src/ 下的三个文件这会大幅降低你贡献代码的难度文件职责你会在这里做什么highlight.rs全部高亮组定义约 800 行新增/调整某个语法高亮或插件主题conv.rs颜色转换工具一般不用改了解即可main.rsCLI 入口与文件写出一般不用改了解即可高亮定义采用宏 DSL例如hi!(Comment, commentfg, -, -, None, -);颜色语义清晰紫蓝关键字、绿字符串、青常量读起来非常直观。第三步快速上手一个真实改动假设你想新增一个插件的主题适配流程如下在 highlight.rs 中新增高亮组使用hi!()宏并挑选合适的语义色。重新生成配色文件cd generator just build # 等价于 cargo run -- -d ..检查生成结果是否符合预期git diff ../colors/dogrun.vim在 Vim / Neovim 中实测效果nvim -c colorscheme dogrun 小技巧just watch会启动 bacon 热重载模式改完 Rust 代码自动重新生成非常适合反复调色的场景。第四步提交 PR 前先在本地跑一遍完整检查CI 里跑的每一条检查本地都能提前执行。在generator/目录下运行just check它等价于just lint # cargo fmt --check cargo clippy -- -D warnings just test # cargo test其中测试套件位于 generator/tests/例如fzf_generation.rs会校验 fzf 色板的格式与必备色键readme_update.rs会验证 README 中 fzf 配置片段能被正确更新且不破坏周边内容——修改 README 相关逻辑时这些测试就是你最好的护身符。别忘了最后一次just build并提交生成文件否则 CI 会在最后一步直接拦截你。第五步提交 PR 的正确姿势本地检查全部通过后就可以提交代码并发起 PR 了。推荐这样组织提交分开提交源码与产物源码改动一个 commit重新生成的.vim文件一个 commit方便维护者 review。写清楚 PR 描述说明改了什么、为什么改、贴一张改动后的配色效果图图片胜千言。更新 README如果你新增了插件支持记得同步 README.md 中的插件列表它也是仓库规范的一部分。第六步从 Push 到通过 CI 的完整流程推送分支后.github/workflows/ci.yaml 会自动触发名为Build and Test的流水线共 6 道关卡全部通过才算绿Check formattingcargo fmt --check代码格式不符合 rustfmt 规范会直接失败。Run clippycargo clippy --all-targets --all-features -- -D warnings严格模式任何警告都会视为错误。Build以 release 模式编译整个生成器确保产物可发布。Run tests执行cargo test验证 fzf、README 等集成测试全部通过。Check generator is up-to-date最容易翻车的一步CI 会运行cargo run -- -d ..重新生成文件然后git diff比对colors/与autoload/。只要生成结果与已提交文件不一致这一步就会失败——这就是为什么永远记得提交生成文件。缓存加速CI 用actions/cache缓存 cargo 依赖与构建产物同一次提交的依赖只编译一次等待时间并不长。常见 CI 失败原因与解决办法速查失败现象大概率原因解决办法fmt 检查失败代码未格式化运行just fmt后重新提交clippy 报 warning存在未被消除的警告按提示修复直到零警告测试失败逻辑改动影响既有断言阅读 generator/tests/ 中的用例定位问题Generated files are not up-to-date改了源码但没重新生成/提交产物运行just build提交colors/与autoload/下的变更结语你的第一次贡献其实很简单为 vim-dogrun 贡献代码的秘诀只有一句话改 Rust 源码用just build重新生成提交前跑just check并永远带上生成的产物。只要遵循这条路径CI 的绿色对勾几乎唾手可得。从修正一个高亮颜色、适配一个新插件开始你的第一个 PR 很快就会出现在合并列表里。快去试试吧【免费下载链接】vim-dogrun:dog: A dark Neovim / Vim colorscheme for the GUI and 256 / true-color terminals.项目地址: https://gitcode.com/gh_mirrors/vi/vim-dogrun创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考