Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 2.56 KB

Contributing to Visual Multimedia

感谢你改进 Visual Multimedia。这个仓库同时维护公开 Skill、产品无关媒体合同、真实案例和生产脚本;提交应让内容生产者、文件边界、消费者与最终可见结果保持一致。

开始前

  1. 先阅读 SKILL.md 和与改动直接相关的 reference,不要一次加载无关方法。
  2. 查看 AGENTS.md 的仓库级边界与验证分级。
  3. 从当前 main 建立分支,并确认工作树中哪些改动属于本次提交。
  4. 涉及第三方代码、字体、图片、音频、视频或生成素材时,先确认许可证、来源和允许分发的范围。

改动原则

  • 每类成品只保留一个活动真源。不要在 README、脚本或消费者里维护第二套字段表。
  • 公共合同升级时,一次迁移全部活动生产者、案例、验证器、消费者和文档。退出的合同进入 archive/,活动代码不得保留兼容读取、双写或恢复分支。
  • 测试必须沿正式生产链产生输入,再由真实消费者读取。不要用消费端手写数据绕过正在验证的生产者。
  • 不要提交 .env.visual-multimedia.local.json、私人参考库、缓存、临时帧、模型或未经许可的媒体。
  • README 只描述当前可验证的公开能力。新增图片必须来自真实项目结果,并在最终 GitHub 页面检查可读性。

验证

选择能够覆盖改动边界的档位;不带参数时等同于 --fast。

node scripts/check-skill.mjs --fast
node scripts/check-skill.mjs --browser
node scripts/check-skill.mjs --full
改动 最低验证
README、许可证、致谢、纯元数据 --fast
Web starter、editable-media、浏览器时间边界、网页渲染 --browser
schema、素材表示、可移植时间线、交付合同、生产脚本、跨 MediaFlow Pro 边界 --full

目标测试出现系统性问题时再扩大验证范围。文档或许可证改动不需要运行无关的浏览器与媒体端到端测试。

提交说明

Pull request 请说明:

  • 用户可以观察到什么变化;
  • 唯一真源和受影响的生产者、边界、消费者;
  • 运行了哪些检查,以及最终文件、页面或媒体由什么真实消费者确认;
  • 是否涉及许可证、第三方来源、归档、远端元数据或跨仓库合同。

提交前运行 git diff --check,确认没有意外文件、凭据、缓存或生成垃圾。不要强推他人的分支,也不要在没有明确理由和迁移证据时删除历史文件。