Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 3.27 KB

参与制作与贡献

本仓库是自由软件,也是一组自由视频的完整源码;欢迎修正、改进与再创作。新使用者先读 宗旨与原则、快速入门 与 文档地图。

贡献首先改善内容、证据、叙事或接续效率。文档写清判断与依据,避免把流程写长来代替把事情做明白。

许可与第三方制作

向本项目提交或接受委托制作时,确认有权将自己的贡献以 GPL-3.0-or-later 提供,保留既有版权、署名和修改记录。第三方制作同样交付可编辑源码、必要材料和对应版本的公开地址;不能只交成片。外部材料单独核对许可,具体清单与法律边界统一见开源交付与第三方许可。不要求转让版权;接收者依 GPL 保有修改和再分发的权利。

提交什么

类型 要带的内容
文案、事实纠正 片名、句号或成片时刻、完整陈述、一手依据和适用版本;需要时重走人工校对
视听问题 语言、文件版本、时间区间、预期与实际表现、可公开的截图或复现步骤
新作品 本片目录:源码、事实表、审稿记录、经验规则复核、README;生成物另行保存
工具或模板 可复现的问题、实现、对应文档、必要的回归测试;模板改动验证生成结果
规则与流程 为什么改、落在哪些文档、模板与工具、如何验证;反馈原话进 docs/log/feedback.md,通用规则进 docs/lessons.json

工作与提交的边界

  • 原仓库只保留一个 main 分支;外部贡献者在自己的 fork 中准备变更,以 PR 提交。
  • 一次改动只落在一个层级:一部片子的目录、一个系列说明,或仓库级的文档与工具。共享文件的改动单独提交。
  • 开工先看 git status。别人未提交或已暂存的改动属于别人的工作现场,不还原、不覆盖、不混入自己的提交。
  • 提交用路径限定的形式:git commit -m "…" -- <路径>…,只提交自己改过的路径;不用 git add -A、git add .、git commit -a。
  • 新作品用 new.js 新建,不复制一部已完成的作品再批量替换名称。
  • 来源、署名与第三方许可按 取证、角色与权限 与 第三方组件 核对;公开信息先脱敏。

验证

npm ci
npm test
npm run check:repo

按改动增加实际验证:

  • 文档:入口、命令、文件链接与模板是否一致;新文档登记在 docs/README.md。
  • 新建、校对、清理:在隔离测试仓库验证,不拿现有影片试删。
  • 浏览器、模板或引擎:npm run smoke,并按影响补充帧检查或小片段渲染。
  • 媒体管线与交付报告:完整环境上运行 npm run smoke:media,核对实际编码产物及失败分支;普通单元测试不覆盖这些外部程序。
  • 具体影片:该片的 check.js 与 验收。写明未观看、未试听或缺少环境的部分。

PR 说明写清具体问题、变化和验证结果。CI 通过不能代替内容校对与成片验收;未完成的检查写明原因。