跳到主要内容

Contributing to existing libraries / 为已有的节点库贡献代码

源文档地址

在已有的开源节点库上协作，走的是 git 这条路。要给一个已有的节点库贡献代码，你需要 fork 一份，在本地做改动，最后向原仓库发一个 pull request。工作流的大致样子见 git 官方书里的 Contributing to a Project（英文）。

注意，这个流程里很关键的一步是：要能看出原始文档和你改过的文档之间的差别。对文本编程语言来说这挺容易，但对可视化编程 —— 至少对 VL —— 这是最主要的难题之一。到目前为止，还没有简单的办法能快速比较一个文档的两个版本。所以发 pull request 时请把这一点放在心上：接收方可能很难弄明白你到底改了什么。因此请尽量做到：

  • 把新增／删除／修改分成不同的 pull request 提交
  • 如果你的改动只是新增，尽量把它们放在一个单独的 .vl 文档里
  • 一定要用文字把你的改动讲清楚
  • 考虑在 pull request 里附上改动前后的截图

源码包仓库​

要在仓库的本地副本上干活，建议你建一个这样的目录：

vl-libs\

然后把所有仓库都克隆进去。比如你想给 VL.Audio 和 VL.Devices.Kinect2 这两个包做贡献，你的目录结构就会是这样：

vl-libs\VL.Audio\
vl-libs\VL.Devices.Kinect2\

像这样、底下装着一个或多个 vvvv 包源码子目录的目录，就叫作一个package repository（包仓库）。要让 vvvv 知道某个包仓库的存在，通过命令行参数指定它的路径：

--package-repositories C:\Users\foo\Documents\repos\vl-libs

如果你想把不同的包仓库维护在不同的目录里，当然也可以指定多个路径：

--package-repositories "C:\Users\foo\Documents\repos\vl-libs;C:\Users\foo\Documents\repos\vl-libs2"

在包仓库路径下找到的包，会和你装过的任何其他 NuGet 一样出现在 Dependencies > VL Nugets 里。所以你可以在任意 .vl 文档里直接引用它们、在它们上面干活。不过要注意，有些包带 C# 解决方案，得先编译过这个包才能用！

默认情况下源码包是只读的，也就是说你没法在 vvvv 里编辑它们。想让某些包可编辑，你得通过命令行参数把它们指定为可编辑的包，比如：

--editable-packages VL.Audio;VL.Devices*

在源码包和二进制包之间切换​

比如说，你一开始把 VL.Audio 当作 NuGet 装了，后来决定 fork 它、把源码克隆下来当作源码包来改。只要把源码放进你的包仓库路径、并把这个路径告诉 vvvv，vvvv 就会优先用源码包而不是同名的二进制 NuGet。这样一来，只要设不设包仓库路径这一个开关，你就能方便地在「直接使用受版本管理的源码」和「使用同名的二进制包」之间来回切换。